Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

chore: Semantic release #27

Merged
merged 4 commits into from
Jun 23, 2023
Merged

chore: Semantic release #27

merged 4 commits into from
Jun 23, 2023

Conversation

anthonypecchillo
Copy link
Contributor

@anthonypecchillo anthonypecchillo commented Jun 23, 2023

Semantic Release

Resolves #26.

Summary

Automates the publishing of updates for @sort/react-components to NPM.

Changes

  • Created a new GitHub Workflow in release.yml. Relies on semantic-release.
  • Bumped Node version in test.yml to LTS.

How It Works

Using fix:, feat:, etc. in Commit Messages:

Conventional commits prefix commit messages with a type, which communicates the kind of changes that have been made in the commit. The most common types include:

fix: This indicates a bug fix, and correlates with PATCH in semantic versioning. Patch release (increments the last number). E.g., 1.0.1 -> 1.0.2

Example commit message:

fix: correct minor typos in code

feat: This indicates a new feature, and correlates with MINOR in semantic versioning. Minor release (increments the middle number). E.g., 1.0.1 -> 1.1.0

Example commit message:

feat: add new dashboard view

Breaking Changes

For both fix: and feat:, if you append a ! after the type/scope, it is interpreted as a BREAKING CHANGE, which correlates with MAJOR in semantic versioning. Major release (increments the first number). E.g., 1.0.1 -> 2.0.0

Example commit message:

feat!: drop support for Node 10

Other Commit Types

Other types include chore:, docs:, style:, refactor:, perf:, test:, and others.

These types don't correlate with semantic versioning and don't trigger a release when used alone. They can be used to provide a more granular view of what work was done in the commit.

Always follow the type with a colon and a space, then provide a short, descriptive message about the changes. For example:

docs: update README with new screenshots.

Note: On Revert Commits

  • If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit.
  • In the body, it should say: "This reverts commit .", where the hash is the SHA of the commit being reverted.
  • A revert correlates with a PATCH version.

Copy link
Member

@aheckmann aheckmann left a comment

Choose a reason for hiding this comment

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

Nice!

@anthonypecchillo anthonypecchillo merged commit 36fbe9b into main Jun 23, 2023
3 checks passed
@anthonypecchillo anthonypecchillo deleted the semantic-release branch June 23, 2023 23:35
anthonypecchillo added a commit that referenced this pull request Jun 23, 2023
* chore: add semantic-release dependency

* chore: init semantic release GitHub workflow

* fix: bump node version in CI to LTS

* chore: add "semantic-release" script to package.json
anthonypecchillo added a commit that referenced this pull request Jun 24, 2023
* chore: transpile modern JS features for older browsers

* chore: Semantic release (#27)

* chore: add semantic-release dependency

* chore: init semantic release GitHub workflow

* fix: bump node version in CI to LTS

* chore: add "semantic-release" script to package.json

* chore: transpile modern JS features for older browsers

* fix: update package-lock after rebase

* fix: resolve post-rebase issues (part 1)

* fix: resolve post-rebase issues (part 2)
@github-actions
Copy link

github-actions bot commented Jul 5, 2023

🎉 This PR is included in version 0.1.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Semantic Release
2 participants