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.

Sign up for GitHub

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

Add RELEASE.md #818

Merged
merged 2 commits into from
Apr 22, 2024
Merged

Add RELEASE.md #818

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e90ba9
Adds a release.md
planktonic Apr 18, 2024
961a357
Refining text
planktonic Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# How to make a release

1. From the commit you wish to publish as a new release (most often that’s from a freshly-pulled `main`), switch to a new branch.
1. Update the version number in `package.json`.
1. Update CHANGELOG.md. If there is an `UNRELEASED` section, change that to the following format: `## [[<version number>]](https://github.com/bitcrowd/bitstyles/releases/tag/<version-number>) - <date>`, replacing `<version-number>` with the new version number, and `<date>` with the current date.
1. Push the branch and create a PR from it.
1. Once your PR is merged, switch to the `main` branch and pull.
1. Create a git tag for the new version with `git tag -a v<version-number> -m "v<version-number>"`, where `<version-number>` is the new version number.
1. Push the new tag to github with `git push --tags`.
1. Run `yarn` then `yarn build` to create the built CSS file in `/build`. Do not check this in (it is in `.gitignore`).
1. If you are publishing the latest version, publish to NPM with `npm publish` (this will include the built CSS). If you are not publishing the latest version (perhaps you’re publishing a patch to an earlier version), you need to specify an npm tag. This is not the same thing as a git tag! To publish a newer version of an older major version number, use e.g. `npm publish --tag version-5`, using the correct major version number.
Loading