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

update: migrate to GitHub Releases with simplified labels #28

Merged
merged 5 commits into from
Dec 15, 2024

Conversation

ichoosetoaccept
Copy link
Owner

@ichoosetoaccept ichoosetoaccept commented Dec 15, 2024

Part 1 of 3: Migrate to GitHub Releases (#27)

This PR sets up the foundation for using GitHub's native release notes system with a simplified labeling approach.

Changes

  1. Added .github/release.yml with three categories:

    • 📚 Content: Documentation and content changes
    • 🛠 Maintenance: Repository and workflow changes
    • Other Changes: Everything else
  2. Updated CHANGELOG.md:

    • Added transition notice
    • Updated versioning info to CalVer
    • Kept for historical purposes
  3. Updated CONTRIBUTING.md:

    • Simplified PR labeling system
    • Updated release process documentation
  4. Updated package.json:

    • Removed auto-changelog dependency
    • Removed related scripts

Next Steps

  • Part 2: Version management changes (removing auto-release.yml, adding tag creation)
  • Part 3: Final cleanup (remaining automation, hooks)

Resolves #27 (1/3)

@ichoosetoaccept ichoosetoaccept linked an issue Dec 15, 2024 that may be closed by this pull request
4 tasks
@ichoosetoaccept ichoosetoaccept added the meta Repository maintenance and workflow changes label Dec 15, 2024
@ichoosetoaccept
Copy link
Owner Author

Testing Plan for GitHub Release Categories:

  1. First, we'll merge this PR (update: migrate to GitHub Releases with simplified labels #28) to set up the base release configuration
  2. Then we'll merge test PR test: verify GitHub Release labels #31 which contains a documentation change
  3. This will help us verify that:
    • Release notes are generated correctly
    • The documentation change appears under "📚 Content" category
    • Labels are working as expected

Once we confirm everything works as intended with the base setup, we can proceed with:

@ichoosetoaccept ichoosetoaccept merged commit a4c773e into main Dec 15, 2024
2 of 3 checks passed
@ichoosetoaccept ichoosetoaccept deleted the feat/github-release-notes branch December 15, 2024 15:45
Copy link

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Repository maintenance and workflow changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

refactor: migrate to GitHub's automatic release notes
1 participant