Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BF: update changelog conversion from .md to .rst (for sphinx) #5757

merged 4 commits into from Jun 27, 2021


Copy link

@yarikoptic yarikoptic commented Jun 21, 2021

Seems to need quite a bit of workarounds to get an .rst version. See diff comment in Makefile -- sphinx isn't that ready for unicode in section headings, eh heh


  • @jwodder -- we need to call make update-changelog (requires iconv and pandoc) after a new entry for is generated but before it is committed. Adjustments to the changelog.rst in docs/ should be committed as well. If you see how to improve that ugly Makefile rule , feel welcome ;)
  • added allowing for "tests" label without patch or minor

Comments in the Makefile describe all the dance which is apparently
needed.  I have rendered result locally -- looks decenet
=== Do not change lines below ===
 "chain": [
 "cmd": "make update-changelog",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [
 "outputs": [
 "pwd": "."
^^^ Do not change lines above ^^^
@yarikoptic yarikoptic added documentation Documentation-related issue semver-internal Changes only affect the internal API release Create a release when this pr is merged labels Jun 21, 2021
Copy link

codecov bot commented Jun 22, 2021

Codecov Report

Merging #5757 (46f2327) into maint (985413a) will decrease coverage by 36.66%.
The diff coverage is 55.55%.

❗ Current head 46f2327 differs from pull request most recent head 075e962. Consider uploading reports for the commit 075e962 to get more accurate results
Impacted file tree graph

@@             Coverage Diff             @@
##            maint    #5757       +/-   ##
- Coverage   89.89%   53.22%   -36.67%     
  Files         299      297        -2     
  Lines       42350    42302       -48     
- Hits        38069    22515    -15554     
- Misses       4281    19787    +15506     
Impacted Files Coverage Δ
datalad/core/distributed/ 89.84% <ø> (-0.26%) ⬇️
datalad/core/distributed/ 88.52% <ø> (ø)
datalad/core/local/ 92.36% <ø> (-0.70%) ⬇️
datalad/core/local/ 90.62% <ø> (ø)
datalad/core/local/ 98.23% <ø> (-0.89%) ⬇️
datalad/core/local/ 96.42% <ø> (ø)
datalad/distributed/ 59.41% <ø> (-22.95%) ⬇️
datalad/distributed/ 38.46% <ø> (-43.08%) ⬇️
datalad/distribution/ 47.60% <ø> (-38.31%) ⬇️
datalad/distribution/ 84.37% <ø> (ø)
... and 242 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 25a9ff7...075e962. Read the comment docs.

Copy link

jwodder commented Jun 22, 2021

@yarikoptic Rather than futzing with pull requests on pull requests, I'll just tell you what changes need to be made.

  • Modify .github/workflows/release.yml to install pandoc before running ~/auto shipit (iconv is already installed)

  • Add the following line to .autorc above the "afterRelease" line:

      "afterChangelog": "make update-changelog && git add docs/source/changelog.rst && git commit -m '[skip ci] Update RST changelog'",

    It might be cleaner to add the git add && git commit to the Makefile rule instead, though.

Also, note the following:

  • Assuming that the Unicode problem is entirely due to the emojis in the label sections, an alternative to using iconv would be to modify the labels' changelogTitle strings in the configuration.
  • If we ever run into the E2BIG error again, I believe it would now occur at the afterChangelog stage, killing the release entirely. The best way around this (as far as I know) would be this plugin, but the devs haven't responded to my comment about how exactly to use it. I'm going to try it out in a test repository and get back to you.

Copy link
Member Author

Thank you @jwodder !!! I will meanwhile merge as is, since we might need to kick out release soonish to accompany joss publication.

@yarikoptic yarikoptic merged commit a7d8c60 into datalad:maint Jun 27, 2021
@yarikoptic yarikoptic deleted the bf-update-changelog branch October 8, 2021 14:13
@jwodder jwodder added the release automation Automatic release and changelog generation label Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
documentation Documentation-related issue release automation Automatic release and changelog generation release Create a release when this pr is merged semver-internal Changes only affect the internal API
None yet

Successfully merging this pull request may close these issues.

None yet

2 participants