Skip to content

docs: add automated changelog documentation #7

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

Merged
merged 2 commits into from
Nov 19, 2024

Conversation

PeterVinter
Copy link
Owner

This PR adds documentation about the automated changelog workflow to README.md.

  • Documents automatic CHANGELOG.md updates
  • Explains change type detection from PR titles
  • Describes version increment process
  • Notes PR creation for changelog updates

Adds a GitHub Actions workflow that:
- Triggers when PRs are merged to main
- Automatically updates CHANGELOG.md
- Creates a new PR with the changelog update
- Determines change type from PR title
- Increments version number automatically
Adds information about:
- Automated CHANGELOG.md updates
- Change type detection
- Version increments
- PR creation
@PeterVinter PeterVinter merged commit 4861ff0 into main Nov 19, 2024
4 checks passed
@PeterVinter PeterVinter deleted the test/changelog-workflow branch November 19, 2024 23:30
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