-
Notifications
You must be signed in to change notification settings - Fork 110
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
Release process still has gotchas #7052
Comments
|
FWIW the one in datalad-next which is AFAIK generated by scriv: https://raw.githubusercontent.com/datalad/datalad-next/main/CHANGELOG.md
@mih -- |
@mih -- did you use @jwodder I think we might better indeed
i.e. to not rely on scriv+github release mechanism |
@yarikoptic The HTML anchor tags were added in scriv in response to nedbat/scriv#46, which seems like the proper place to comment on your desire for getting rid of them. |
What mechanism are you expecting to be used for this? As far as I'm aware, if no release notes are supplied when a GitHub release is created, GitHub will default to displaying the body of the tag annotation or tagged commit message (not sure which) in monospace. Creating a release properly means supplying the release notes in the API request (i.e., ignoring whatever's in the annotated tag), at which point we might as well use scriv. |
How exactly should I extract that? |
@yarikoptic Issues with entry separators reported to scriv at: nedbat/scriv#62 |
could you please check how
something like this in bash - tune to your liking, probably also removing more header lines since we do not need to repeat the version in the release record etc.
|
re html tags, ok -- let's just keep them for now, not the major hassle. |
I'm positive that auto just uses the GitHub API and supplies the release notes in the request body. Note that auto's tag annotations are all of the form "Update version to 0.46.3"; they do not include the new CHANGELOG section. Is there really a need to include the CHANGELOG in the tag annotation? |
it could well be -- how do they get then annotated git tags?
not really. I just did and considered it a good practice, but does not have to be really. ok to not do it. I am going to fix up CHANGELOG.md and .rst now -- our CI is failing etc. I will push directly into |
another gotcha is that if we are to keep html tags, then need to have an empty line after for |
The annotated tags are created in a separate operation from the GitHub releases. |
@yarikoptic So what do you want the tag annotation messages to say? |
if not changelog -- keep consistent with auto e.g. |
@yarikoptic I've successfully tested the requested changes in https://github.com/datalad/temp-release-devel. The latest release includes emoji in the category headers (also in the CHANGELOG), and the lines are not broken. GitHub doesn't seem to display tag annotations in a way that distinguishes them from lightweight tags, but you can still see the tag message by clicking on the ellipsis next to "0.0.2" in https://github.com/datalad/temp-release-devel/tags. This just leaves the matter of the CHANGELOG section divider. |
re tags - cool. Confirmed locally by cloning and
;) re divider: dropped an idea in nedbat/scriv#62 (comment) . And we lack new line since we do not have it in our |
@yarikoptic As I understand scriv, |
@jwodder - would you be so kind to go through original checklist of issues and mark the ones which were already dealt with in the datalad/release-action (just ran into nonannotated tag so decided to check if known/addressed) |
@yarikoptic The only remaining issue not fixed in release-action is the section divider issue, which requires changes on scriv's end. |
please file an issue. IIRC also using |
@yarikoptic I already filed an issue: nedbat/scriv#62. |
We have just released 0.9.4 This is likely fallout from the switch to edit by @yarikoptic: dedicated issue - #7146 |
Are you aware of something that still needs doing here, @yarikoptic ? |
I think we are ok, thanks! |
woohoo -- 0.17.6 was finally "auto-released" without
auto
. The last fix needed was #7051 to make secrets available.A few gotchas to be addressed:
git tag -m "{changelog entries}" "{tag}"
and thengit push -f {tag}
"manually" to overload the one produced by github. Or, better, suggestingscriv
(I guess it was the one which triggered it) to do that/similar act.scriv
oddity. ifscriv
- please report to it.scriv
:<a id='changelog-0.17.6'></a>
on top --shouldn't be in .md!ok to be in .md# 0.17.5 (Fri Sep 02 2022)
. might be worth to suggest to use---
divider as we had from auto.rst
version lost 0.17.5 section separator completely! https://github.com/datalad/datalad/blob/0.17.6/docs/source/changelog.rstedit: fixes should be implemented and tested on some test repo first.
The text was updated successfully, but these errors were encountered: