From 084d04f41de0465a81c81c75687a6f31d8eb57a8 Mon Sep 17 00:00:00 2001 From: Gabriel Montes Date: Tue, 5 Nov 2024 10:26:29 -0500 Subject: [PATCH 1/2] Improve the release process docs --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0a5f4a9..0c39a6a 100644 --- a/README.md +++ b/README.md @@ -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 the 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' Date: Wed, 6 Nov 2024 12:00:32 -0500 Subject: [PATCH 2/2] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c39a6a..dfc4a8e 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Enforcing code styles should be mainly done with tools like [Prettier](https://p ## Release process -After creating the a feature branch and committing the changes, add a commit to update the package version: +After creating a feature branch and committing the changes, add a commit to update the package version: ```sh npm version $VERSION # Use major|minor|parch as needed