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

ci: Add release.yml for changelog generation #349

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

VaclavElias
Copy link

This PR is just a preparation for auto generation of release notes. Once merged, it isn't going to do anything yet, till the GitHub Action is updated. I will make a follow up PR(s).

Feel free to rename titles and labels as desired.

Important notes:

  • exclude section excludes certain PRs in the release notes, for example from dependabot
  • you need to create the labels so the release notes will be catogorised accordingly:
    • ignore-for-release
    • breaking-change
    • new-feature
    • performance
    • fiddling
    • demos
    • documentation
  • you must label each PR, which you would like to categorised, otherwise it will appear in the Other Changes section.
  • ideally, if the conditions allow, the PRs should be split according these labels 🤣

Other notes:

  • Added a new release.yml file to the .github directory.
  • Configures the changelog generation for releases.
  • Specifies labels to exclude from the changelog, such as ignore-for-release and contributions from dependabot.
  • Categorizes the changelog into several sections

- Added a new `release.yml` file to the `.github` directory.
- Configures the changelog generation for releases.
- Specifies labels to exclude from the changelog, such as `ignore-for-release` and contributions from `dependabot`.
- Categorizes the changelog into several sections
@VaclavElias VaclavElias mentioned this pull request Dec 16, 2024
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.

1 participant