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

Improve the release process docs #52

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Improve the release process docs #52

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
084d04f
Improve the release process docs
gabmontes Nov 5, 2024
d452764
Fix typo
gabmontes Nov 6, 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
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,22 @@ Enforcing code styles should be mainly done with tools like [Prettier](https://p

## Release process

Create a feature branch, commit and push the changes, and open a PR:
After creating a feature branch and committing the changes, add a commit to update the package version:

```sh
git checkout -b $BRANCH
# Commit the changes
npm version $VERSION # Use major|minor|parch
git push -u origin $BRANCH
# Open a PR
npm version $VERSION # Use major|minor|parch as needed
git push --set-upstream origin $BRANCH
```

Once the PR is approved, merge the changes locally, apply and push a version tag, and create a release:
Once the commits are pushed, [open a PR](https://github.com/bloq/eslint-config-bloq/pulls).

Then, when the PR is approved, merge the changes locally, apply and push a version tag if needed:

```sh
git checkout master
git merge --ff $BRANCH
git tag -s -m "" v$(jq -r '.version' <package.json)
TAG=v$(jq --raw-output '.version' <package.json); git tag --list $TAG | grep --quiet "^$TAG$" || git tag --sign --message="" $TAG
git push --follow-tags
# Create a new release
```

Finally, [create a release](https://github.com/bloq/eslint-config-bloq/releases) to trigger the publication to NPM.
Loading