Skip to content

Add release workflow#629

Closed
Goooler wants to merge 1 commit intoolivierlacan:mainfrom
Goooler:release-workflow
Closed

Add release workflow#629
Goooler wants to merge 1 commit intoolivierlacan:mainfrom
Goooler:release-workflow

Conversation

@Goooler
Copy link

@Goooler Goooler commented Jul 5, 2024

GitHub releases will be triggered by tags pushing, you can also add some steps like website deployment in this workflow.

@Goooler
Copy link
Author

Goooler commented Jul 5, 2024

View the release result at https://github.com/Goooler/keep-a-changelog/releases/tag/v1.1.1.

@Goooler Goooler force-pushed the release-workflow branch from 3bc23b3 to 05bcaa2 Compare July 5, 2024 00:26
GitHub releases will be triggered by tags pushing, you can also add some steps like website deployment in this workflow.
@Goooler Goooler force-pushed the release-workflow branch from 05bcaa2 to a93c5ff Compare July 5, 2024 00:36
with:
release_notes_file: RELEASE_NOTES.md
- name: Create release
run: gh release create ${{ github.ref_name }} --notes-file RELEASE_NOTES.md
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can try --notes-from-tag option here, but there are some workarounds for it. See Goooler#1.

@olivierlacan
Copy link
Owner

Interesting @Goooler, I see this relies on https://github.com/ffurrer2/extract-release-notes

I don't really need automated tooling to produce GitHub Release posts on this project since they're infrequent but it's a really interesting option for folks who prefer using their changelog text files as a source of truth and derive proprietary release posts from GitHub from them.

It makes me thing Keep a Changelog 2.0 should recommend this pattern: if you're going to use hosting-platform specific release posts, copy/generate them from the canonical changelog file.

Thank you. I'm not going to merge this since it adds a dependency I don't really need but I think it's a good idea. 😃

@Goooler
Copy link
Author

Goooler commented Mar 31, 2025

And the feature request for GH cli was addressed to cli/cli#9276.

@Goooler Goooler deleted the release-workflow branch March 31, 2025 15:06
olivierlacan added a commit that referenced this pull request Mar 31, 2025
As discussed in a recent [PR][1], people should treat their 
changelogs as canonical sources given their portability. 

Release posts can easily be created manually or automatically
since the Keep a Changelog format is easy to parse for both 
humans and machines.

[1]: #629 (comment)
@olivierlacan
Copy link
Owner

Addressed in d93bdfd as part of #600

@Goooler
Copy link
Author

Goooler commented Mar 31, 2025

Good to see!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants