https://github.com/hoganb/semantic-release

semantic-release automates the whole package release workflow [typescript, semantic-release, conventional-commits, github-actions]
https://github.com/hoganb/semantic-release

conventional-commits github-actions semantic-release typescript

Last synced: 19 days ago
JSON representation

semantic-release automates the whole package release workflow [typescript, semantic-release, conventional-commits, github-actions]

• Host: GitHub
• URL: https://github.com/hoganb/semantic-release
• Owner: hoganb
• License: mit
• Created: 2022-08-24T11:04:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-08T16:38:42.000Z (about 2 years ago)
• Last Synced: 2024-11-21T15:20:19.851Z (about 1 month ago)
• Topics: conventional-commits, github-actions, semantic-release, typescript
• Language: TypeScript
• Homepage:
• Size: 153 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @hoganb/semantic-release

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

semantic-release automates the whole package release workflow including:

- Determining the next semantic version number based upon conventional commits

- Generating the release notes

- Publishing the package to public npm registry 

## Notes

Branch protection to push directly to `main` branch **disabled** in order for the *semantic-release* bot to update package version (in both `package-lock.json` and `package.json`) and `CHANGELOG.md` files on release.

## Q&A

Q. How does it determine the next version number and generate release notes?

- A. It uses formalized commit messages. e.g. fix: for patch version, feat: for minor version, and BREAKING_CHANGE: for the major version

Q. How does it publish the package?

- A. It internally run command of npm publish using npm token

### Footer

Add footer note