Skip to content

Commit

Permalink
fix: grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
kilted-andres committed Sep 16, 2024
1 parent 73bbc45 commit 4555099
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/internal.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -82,25 +82,25 @@ 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).
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.
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.
Expand Down

0 comments on commit 4555099

Please sign in to comment.