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

meta: switch to semantic-release #72

Merged
merged 9 commits into from
Jan 21, 2025

Conversation

ichoosetoaccept
Copy link
Owner

This PR switches our versioning system from custom date-based versioning to semantic-release for better automation and clarity.

Changes

  1. Removed Custom Versioning:

    • Removed date-based versioning workflows
    • Removed manual release process
    • Removed version field from package.json
  2. Added Semantic Release:

    • Added semantic-release configuration
    • Added GitHub Actions workflow for automated releases
    • Added necessary dependencies
  3. Updated Documentation:

    • Updated CONTRIBUTING.md with detailed versioning information
    • Added examples of how commits affect versions
    • Clarified what changes trigger which version bumps

Impact

After this PR is merged:

  • Version numbers will follow semantic versioning (MAJOR.MINOR.PATCH)
  • Releases will be created automatically based on commit messages
  • Release notes will be generated from commit messages
  • First release will start at 1.0.0

Examples

Your commit message determines the next version:

# Patch release (1.0.0 -> 1.0.1)
git commit -m "fix: correct typo in installation guide"

# Minor release (1.0.0 -> 1.1.0)
git commit -m "feat: add new section on windsurfing spots"

# Major release (1.0.0 -> 2.0.0)
git commit -m "feat: reorganize entire documentation structure

BREAKING CHANGE: All sections have been reorganized with a new structure"

Closes #70

- Remove custom versioning workflows
- Add semantic-release configuration
- Update CONTRIBUTING.md with versioning details
- Add semantic-release dependencies

This change moves us from our custom date-based versioning to semantic versioning
using semantic-release. This will provide better clarity about the impact of
changes and automate our release process.
@ichoosetoaccept ichoosetoaccept added the meta Repository maintenance and workflow changes label Jan 21, 2025
@ichoosetoaccept ichoosetoaccept merged commit 1206151 into main Jan 21, 2025
3 checks passed
@ichoosetoaccept ichoosetoaccept deleted the meta/switch-to-semantic-release branch January 21, 2025 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.

meta: simplify GitHub workflows to match local setup
1 participant