From a3b9386fadb6bc86f4f9b62a396912fd29cb41fb Mon Sep 17 00:00:00 2001 From: Jacob Heun Date: Tue, 8 Oct 2024 10:07:27 +0200 Subject: [PATCH 1/3] docs: add note about npm versioning --- .github/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/README.md b/.github/README.md index e6a55660..1c9d3388 100644 --- a/.github/README.md +++ b/.github/README.md @@ -85,8 +85,8 @@ yarn test A GitHub Action has been developed to help automate package releases. All that you will need to do is: -1. Make sure to increase the `version` field in the **package.json** +1. Make sure to increase the `version` field in the **package.json**. `npm version [major | minor | patch]` will handle the versioning and commit for you. 2. On the GitHub repo's home page, navigate to the righthand side and click on **Create a new release** 3. Give the release a `title` and `description` outlining the changes made in the release 4. Choose/Create a **tag** corresponding to the new version that was added in the package.json in **step 1** -5. Once the details are filled out, submit the release. You will get taken to a confirmation page. This process will automatically trigger the GitHub action that will publish the package to npm. +5. Once the details are filled out, submit the release. You will get taken to a confirmation page. This process will automatically trigger the GitHub action that will publish the package to npm. From 29abd2dc29601f6e26dd1d82f170bc7f125a260c Mon Sep 17 00:00:00 2001 From: Jacob Heun Date: Tue, 8 Oct 2024 10:07:32 +0200 Subject: [PATCH 2/3] 4.3.0 --- package-lock.json | 4 ++-- package.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 235a05a6..00509a24 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@code4rena/components-library", - "version": "4.2.1", + "version": "4.3.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@code4rena/components-library", - "version": "4.2.1", + "version": "4.3.0", "license": "ISC", "dependencies": { "clsx": "^1.2.1", diff --git a/package.json b/package.json index fb44e180..6b1ab80f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@code4rena/components-library", - "version": "4.2.1", + "version": "4.3.0", "description": "Code4rena's official components library ", "types": "./dist/lib.d.ts", "exports": { @@ -84,4 +84,4 @@ "@babel/preset-react" ] } -} \ No newline at end of file +} From 4970e3aebcd51a9b02d138562ca3ddd602b86d3f Mon Sep 17 00:00:00 2001 From: Jacob Heun Date: Tue, 8 Oct 2024 10:08:55 +0200 Subject: [PATCH 3/3] docs: add not about npm version making the tag --- .github/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/README.md b/.github/README.md index 1c9d3388..ef68d24e 100644 --- a/.github/README.md +++ b/.github/README.md @@ -85,7 +85,7 @@ yarn test A GitHub Action has been developed to help automate package releases. All that you will need to do is: -1. Make sure to increase the `version` field in the **package.json**. `npm version [major | minor | patch]` will handle the versioning and commit for you. +1. Make sure to increase the `version` field in the **package.json**. `npm version [major | minor | patch]` will handle the versioning, commit, and tag creation for you. 2. On the GitHub repo's home page, navigate to the righthand side and click on **Create a new release** 3. Give the release a `title` and `description` outlining the changes made in the release 4. Choose/Create a **tag** corresponding to the new version that was added in the package.json in **step 1**