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.

Sign up for GitHub

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

Jump to bottom

Improve generation of changelog for GitHub release #6134

Open
dstansby opened this issue May 6, 2022 · 1 comment
Open

Improve generation of changelog for GitHub release #6134

dstansby opened this issue May 6, 2022 · 1 comment
Labels
Effort Medium Requires a moderate time investment Feature Request New feature wanted! Infrastructure Issues or PRs that affect the CI or packaging of SunPy Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required

Comments

@dstansby
Copy link
Member

dstansby commented May 6, 2022

Describe the feature

When creating a GitHub release the changelog needs to be generated from our own changelog. The steps for this are:

  1. Run pandoc --wrap=none -t markdown_strict CHANGELOG.rst
  2. Manually extract the relevant bit (the topmost section)
  3. Paste into the GH release

I think 2. could be easily automated with a new small script in the tools directory.

Proposed solution

No response
@dstansby dstansby added the Feature Request New feature wanted! label May 6, 2022
@nabobalis nabobalis added Priority Low Slow action required Effort Medium Requires a moderate time investment Infrastructure Issues or PRs that affect the CI or packaging of SunPy Package Novice Requires little knowledge of the internal structure of SunPy labels May 6, 2022
@Cadair
Copy link
Member

Cadair commented May 11, 2022

We could make a GitHub action which does all of this on a new tag (not on main).

  • Extract the top section of the changelog
  • Convert to markdown
  • Publish Github release with content and name equal to the tag.

@dstansby dstansby mentioned this issue Jun 9, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Effort Medium Requires a moderate time investment Feature Request New feature wanted! Infrastructure Issues or PRs that affect the CI or packaging of SunPy Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Cadair @nabobalis @dstansby