From 05a72b24d4b8b21ef260f9764fa0c838c8c3d3c9 Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Wed, 11 Sep 2024 11:30:00 +0200 Subject: [PATCH 01/11] feat: command to easily build internal version --- package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/package.json b/package.json index 4b9fbfc0b..4044b8ae6 100644 --- a/package.json +++ b/package.json @@ -27,6 +27,7 @@ }, "scripts": { "build": "env NODE_ENV=production webpack", + "build-internal": "env VARIANT=internal NODE_ENV=production webpack", "package": "cd dist && web-ext build --overwrite-dest", "dev": "env VARIANT=internal NODE_ENV=development webpack --watch", "dev-public": "env VARIANT=public NODE_ENV=development webpack --watch", From ff69ffeaa305c7c72424bd0394129bb43edaee11 Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Wed, 11 Sep 2024 11:30:30 +0200 Subject: [PATCH 02/11] feat: explain how to build and package internal version --- docs/internal.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/internal.md b/docs/internal.md index 733525524..289232d48 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -55,6 +55,8 @@ yarn dev Update the version in `src/static/manifest.json` and `src/configuration/configuration.ts`. +### For the external version + Run the following commands: ``` @@ -64,6 +66,20 @@ yarn package ``` This will generate a file `dist/web-ext-artifacts/sporran-???.zip` ready to be uploaded to stores. +This version will only connect to _KILT Spirinet_ blockchain via predefined node endpoints. + +### For the internal version + +Run the following commands: + +``` +yarn install +yarn build-internal +yarn package +``` + +This will generate a file `dist/web-ext-artifacts/sporran-???.zip` ready to be uploaded on the github's release site for developers to use. +This version will connect to any node endpoints the user inputs and by default to the _KILT Peregrine_ blockchain. ## Built with From 2bb3f834f683f170011d76cf5a2ce06b11c8c99e Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Wed, 11 Sep 2024 12:20:37 +0200 Subject: [PATCH 03/11] feat: explain how to release sporran for developers --- docs/internal.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/internal.md b/docs/internal.md index 289232d48..b02574013 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -66,7 +66,7 @@ yarn package ``` This will generate a file `dist/web-ext-artifacts/sporran-???.zip` ready to be uploaded to stores. -This version will only connect to _KILT Spirinet_ blockchain via predefined node endpoints. +This version will only connect to _KILT Spiritnet_ blockchain via predefined node endpoints. ### For the internal version @@ -78,9 +78,35 @@ yarn build-internal yarn package ``` -This will generate a file `dist/web-ext-artifacts/sporran-???.zip` ready to be uploaded on the github's release site for developers to use. +This will generate a file `dist/web-ext-artifacts/sporran-???.zip` ready for developers to use. This version will connect to any node endpoints the user inputs and by default to the _KILT Peregrine_ blockchain. +## Uploading to the release site + +We recommend external developers to download the test version of the Sporran extension from [the release page on github](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). +The uploads to this page occur manually. +Only Sporran versions using changes merged to `main` should be publish as releases. + +To get a Sporran Extension you could upload on the release, either [build and package it locally](#For-the-internal-version) or alternatively, you could: + +1. Merge the wished changes to `main`. +2. Go out the [Sporran GitHub's Actions page for "Packages the internal version"](https://github.com/BTE-Trusted-Entity/sporran-extension/actions/workflows/publish.yaml). +3. Click on the workflow of the wished commit. +4. Download the artifact. + +Before updating it to the release site, please prepend a _"TEST-"_ to the zip file's name. +If you got the extension from the github workflow, it would be nice to replace the commit hash with the sporran version on the zip's name. + +To uploaded: + +1. Got to [the release page](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). +2. Copy title and description of an older release. +3. Click on [Draft a new release](https://github.com/BTE-Trusted-Entity/sporran-extension/releases/new) +4. Paste title and description and attach the Sporran extension zip file. +5. Choose as tag the version of Sporran being release. + You can directly create the tag while publishing the release. +6. Publish the release. + ## Built with - [React](https://reactjs.org) From 3013395398a5a08184ed4ce49967b3356daef58f Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Wed, 11 Sep 2024 12:26:32 +0200 Subject: [PATCH 04/11] fix: wipe lie --- docs/internal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/internal.md b/docs/internal.md index b02574013..5812f241f 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -30,7 +30,7 @@ yarn dev 1. Go to [actions page for "Packages the internal version"](https://github.com/KILTprotocol/sporran-extension/actions/workflows/publish.yaml). 1. Click on the build you want to test. 1. Download the extension file from the _Artifacts_ section at the bottom. -1. Unpack the downloaded _.zip_ file and unpack the _sporran-???.zip_ from it as well. +1. Unpack the downloaded _sporran-???.zip_ file. ### Getting the _public_ version of extension From d2552acbf3b368b6a059f0e37d7524ded5e9f829 Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Wed, 11 Sep 2024 12:28:45 +0200 Subject: [PATCH 05/11] feat: add dev-public to list of scripts --- docs/internal.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/internal.md b/docs/internal.md index 5812f241f..9d10f3f95 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -13,7 +13,8 @@ yarn dev ## Scripts -- `yarn dev` - run `webpack` in `watch` mode +- `yarn dev` - run `webpack` in `watch` mode using the "internal" variant +- `yarn dev-public` - run `webpack` in `watch` mode using the "public" variant - `yarn storybook` - runs the Storybook server - `yarn build` - builds the production-ready unpacked extension - `yarn package` - packages the built code for upload From cbe9c24a9b095d42f6942a1231efe13032bb4cfe Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Mon, 16 Sep 2024 14:50:42 +0200 Subject: [PATCH 06/11] fix: turn release into plural --- docs/internal.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/internal.md b/docs/internal.md index 9d10f3f95..35f25fafe 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -84,7 +84,7 @@ This version will connect to any node endpoints the user inputs and by default t ## Uploading to the release site -We recommend external developers to download the test version of the Sporran extension from [the release page on github](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). +We recommend external developers to download the test version of the Sporran extension from [the releases page on github](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). The uploads to this page occur manually. Only Sporran versions using changes merged to `main` should be publish as releases. @@ -100,7 +100,7 @@ If you got the extension from the github workflow, it would be nice to replace t To uploaded: -1. Got to [the release page](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). +1. Go to [the releases page](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). 2. Copy title and description of an older release. 3. Click on [Draft a new release](https://github.com/BTE-Trusted-Entity/sporran-extension/releases/new) 4. Paste title and description and attach the Sporran extension zip file. From 15999f08fb35d3fb83d2ddde4894f3e6be77ef31 Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Mon, 16 Sep 2024 14:54:06 +0200 Subject: [PATCH 07/11] fix: make sentence readable --- docs/internal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/internal.md b/docs/internal.md index 35f25fafe..7038b6cae 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -88,7 +88,7 @@ We recommend external developers to download the test version of the Sporran ext The uploads to this page occur manually. Only Sporran versions using changes merged to `main` should be publish as releases. -To get a Sporran Extension you could upload on the release, either [build and package it locally](#For-the-internal-version) or alternatively, you could: +To get a releasable Sporran Extension file you could either [build and package it locally](#For-the-internal-version) or ,alternatively, follow this steps: 1. Merge the wished changes to `main`. 2. Go out the [Sporran GitHub's Actions page for "Packages the internal version"](https://github.com/BTE-Trusted-Entity/sporran-extension/actions/workflows/publish.yaml). From 73bbc459fce66a2a1414bd42901e1d16a778faed Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Mon, 16 Sep 2024 14:56:27 +0200 Subject: [PATCH 08/11] fix: preposition --- docs/internal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/internal.md b/docs/internal.md index 7038b6cae..0d63f1650 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -91,7 +91,7 @@ Only Sporran versions using changes merged to `main` should be publish as releas To get a releasable Sporran Extension file you could either [build and package it locally](#For-the-internal-version) or ,alternatively, follow this steps: 1. Merge the wished changes to `main`. -2. Go out the [Sporran GitHub's Actions page for "Packages the internal version"](https://github.com/BTE-Trusted-Entity/sporran-extension/actions/workflows/publish.yaml). +2. Go to the [Sporran GitHub's Actions page for "Packages the internal version"](https://github.com/BTE-Trusted-Entity/sporran-extension/actions/workflows/publish.yaml). 3. Click on the workflow of the wished commit. 4. Download the artifact. From 7f0005f9f4b62423e129ff4e6f83b7ee9124ea42 Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Mon, 16 Sep 2024 15:17:36 +0200 Subject: [PATCH 09/11] fix: grammar --- docs/internal.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/internal.md b/docs/internal.md index 0d63f1650..8bbab0464 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -30,14 +30,14 @@ yarn dev 1. Go to [actions page for "Packages the internal version"](https://github.com/KILTprotocol/sporran-extension/actions/workflows/publish.yaml). 1. Click on the build you want to test. -1. Download the extension file from the _Artifacts_ section at the bottom. +1. Download the extension file from the _Artifact's_ section at the bottom. 1. Unpack the downloaded _sporran-???.zip_ file. ### Getting the _public_ version of extension 1. Go to [actions page for "Packages the public version"](https://github.com/KILTprotocol/sporran-extension/actions/workflows/stores.yaml). 1. Click the buttons "Run workflow" -> "Run workflow" to prepare the public version and wait for the workflow to finish. -1. Click the link for the just finished workflow and download the extension file from the _Artifacts_ section at the bottom. +1. Click the link for the just finished workflow and download the extension file from the _Artifacts'_ section at the bottom. 1. Unpack the downloaded _.zip_ file and unpack the _sporran-???.zip_ from it as well. ### Testing in [Chrome](https://developer.chrome.com/docs/extensions/mv2/getstarted/#manifest) @@ -82,13 +82,13 @@ yarn package This will generate a file `dist/web-ext-artifacts/sporran-???.zip` ready for developers to use. This version will connect to any node endpoints the user inputs and by default to the _KILT Peregrine_ blockchain. -## Uploading to the release site +## Uploading to the release's site -We recommend external developers to download the test version of the Sporran extension from [the releases page on github](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). +We recommend external developers to download the test version of the Sporran extension from [the releases' page on GitHub](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). The uploads to this page occur manually. -Only Sporran versions using changes merged to `main` should be publish as releases. +Only Sporran versions using changes merged to `main` should be published as releases. -To get a releasable Sporran Extension file you could either [build and package it locally](#For-the-internal-version) or ,alternatively, follow this steps: +To get a releasable Sporran Extension file you could either [build and package it locally](#For-the-internal-version) or, alternatively, follow these steps: 1. Merge the wished changes to `main`. 2. Go to the [Sporran GitHub's Actions page for "Packages the internal version"](https://github.com/BTE-Trusted-Entity/sporran-extension/actions/workflows/publish.yaml). @@ -96,15 +96,15 @@ To get a releasable Sporran Extension file you could either [build and package i 4. Download the artifact. Before updating it to the release site, please prepend a _"TEST-"_ to the zip file's name. -If you got the extension from the github workflow, it would be nice to replace the commit hash with the sporran version on the zip's name. +If you got the extension from the GitHub workflow, it would be nice to replace the commit hash with the Sporran version on the zip's name. -To uploaded: +To upload: -1. Go to [the releases page](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). +1. Go to [the releases' page](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). 2. Copy title and description of an older release. 3. Click on [Draft a new release](https://github.com/BTE-Trusted-Entity/sporran-extension/releases/new) 4. Paste title and description and attach the Sporran extension zip file. -5. Choose as tag the version of Sporran being release. +5. Choose as tag the version of Sporran being released. You can directly create the tag while publishing the release. 6. Publish the release. From 14f5f1c25a4e8afba9703ee52027c730e8ded092 Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Mon, 16 Sep 2024 17:48:34 +0200 Subject: [PATCH 10/11] fix: a page is inside a site --- docs/internal.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/internal.md b/docs/internal.md index 8bbab0464..1e082f820 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -82,7 +82,7 @@ yarn package This will generate a file `dist/web-ext-artifacts/sporran-???.zip` ready for developers to use. This version will connect to any node endpoints the user inputs and by default to the _KILT Peregrine_ blockchain. -## Uploading to the release's site +## Uploading to the release's page We recommend external developers to download the test version of the Sporran extension from [the releases' page on GitHub](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). The uploads to this page occur manually. @@ -95,7 +95,7 @@ To get a releasable Sporran Extension file you could either [build and package i 3. Click on the workflow of the wished commit. 4. Download the artifact. -Before updating it to the release site, please prepend a _"TEST-"_ to the zip file's name. +Before updating it to the release page, please prepend a _"TEST-"_ to the zip file's name. If you got the extension from the GitHub workflow, it would be nice to replace the commit hash with the Sporran version on the zip's name. To upload: From 361fea256d193fb719c397814733ec9a1cb279da Mon Sep 17 00:00:00 2001 From: kilted-andres Date: Mon, 16 Sep 2024 17:59:27 +0200 Subject: [PATCH 11/11] fix: socialization of apostrophes -- no more possessiveness --- docs/internal.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/internal.md b/docs/internal.md index 1e082f820..4ab7a77a2 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -30,14 +30,14 @@ yarn dev 1. Go to [actions page for "Packages the internal version"](https://github.com/KILTprotocol/sporran-extension/actions/workflows/publish.yaml). 1. Click on the build you want to test. -1. Download the extension file from the _Artifact's_ section at the bottom. +1. Download the extension file from the _Artifacts_ section at the bottom. 1. Unpack the downloaded _sporran-???.zip_ file. ### Getting the _public_ version of extension 1. Go to [actions page for "Packages the public version"](https://github.com/KILTprotocol/sporran-extension/actions/workflows/stores.yaml). 1. Click the buttons "Run workflow" -> "Run workflow" to prepare the public version and wait for the workflow to finish. -1. Click the link for the just finished workflow and download the extension file from the _Artifacts'_ section at the bottom. +1. Click the link for the just finished workflow and download the extension file from the _Artifacts_ section at the bottom. 1. Unpack the downloaded _.zip_ file and unpack the _sporran-???.zip_ from it as well. ### Testing in [Chrome](https://developer.chrome.com/docs/extensions/mv2/getstarted/#manifest) @@ -82,9 +82,9 @@ yarn package This will generate a file `dist/web-ext-artifacts/sporran-???.zip` ready for developers to use. This version will connect to any node endpoints the user inputs and by default to the _KILT Peregrine_ blockchain. -## Uploading to the release's page +## Uploading to the releases page -We recommend external developers to download the test version of the Sporran extension from [the releases' page on GitHub](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). +We recommend external developers to download the test version of the Sporran extension from [the releases page on GitHub](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). The uploads to this page occur manually. Only Sporran versions using changes merged to `main` should be published as releases. @@ -100,7 +100,7 @@ If you got the extension from the GitHub workflow, it would be nice to replace t To upload: -1. Go to [the releases' page](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). +1. Go to [the releases page](https://github.com/BTE-Trusted-Entity/sporran-extension/releases). 2. Copy title and description of an older release. 3. Click on [Draft a new release](https://github.com/BTE-Trusted-Entity/sporran-extension/releases/new) 4. Paste title and description and attach the Sporran extension zip file.