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

Missing release notes, tags #1036

Closed
jameswilburlewis opened this issue Oct 9, 2024 · 1 comment
Closed

Missing release notes, tags #1036

jameswilburlewis opened this issue Oct 9, 2024 · 1 comment
Assignees
Labels
Documentation Examples, notebooks, installation guides, webinars, etc packaging

Comments

@jameswilburlewis
Copy link
Contributor

We haven't been keeping up with the release notes for pyspedas -- on our github repo it only looks like some of the very early releases have been documented. We should bring this up to date by adding tags for each release, and compiling release notes from the commit history. We might also want to add release notes somewhere on our readthedocs pages.

Going forward, we should ensure that updating the release notes is part of our release workflow.

See also: #1032 and #1031

@jameswilburlewis jameswilburlewis added Documentation Examples, notebooks, installation guides, webinars, etc packaging labels Oct 9, 2024
@jameswilburlewis jameswilburlewis self-assigned this Oct 9, 2024
@jameswilburlewis
Copy link
Contributor Author

We're up to date now. I think I made a few mistakes in the tagging -- I think I was tagging the previous commit rather than the one I intended to tag in a few places. To attach a tag to the previous commit:

git tag -a

for example:

% git tag -a 1.6.2 901d73d

Then use

git push origin --tags

or use the PyCharm to do the push, and make sure that the "push tags" option is checked in the confirmation dialog.

To make the release notes on the Github repo, go to the pyspedas repo page, and click on "Releases" in the right column. There will be a "Draft a new release" button. Click that, select a tag from the dropdown, name it "PySPEDAS vX.Y.Z",. and click on "Generate Release Notes" which gives you the commit log messages between the previous tag and the new tag.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Examples, notebooks, installation guides, webinars, etc packaging
Projects
None yet
Development

No branches or pull requests

1 participant