Skip to content

Commit 01b45c7

Browse files
committed
Add enable of immutable release
1 parent 00a848f commit 01b45c7

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

src/guides/distribution/repository.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@ Now we'll create a repository on Github. This repository will host your plugin c
2323
3. Click the `Create repository` button
2424
4. In your terminal, navigate to your project folder (created in the step 1)
2525

26-
```bash
27-
cd my-plugin
28-
```
26+
```bash
27+
cd my-plugin
28+
```
2929

3030
5. Connect your local project to your Github repository
3131

32-
```bash
33-
git init
34-
git add .
35-
git commit -m "init"
36-
git branch -M main
37-
git remote add origin [email protected]:YOUR_USERNAME/YOUR_REPO_NAME.git
38-
git push -u origin main
39-
```
32+
```bash
33+
git init
34+
git add .
35+
git commit -m "init"
36+
git branch -M main
37+
git remote add origin [email protected]:YOUR_USERNAME/YOUR_REPO_NAME.git
38+
git push -u origin main
39+
```
4040

4141
::: info
4242
The steps above will create a repository under your own account.
@@ -51,7 +51,7 @@ Plugin packages **must** be digitally signed to be installable in Caido.
5151
To sign your plugin package, you need to generate a public/private key-pair.
5252

5353
::: info
54-
Plugin package signing is done using [Ed25519 public-key signatures](https://cendyne.dev/posts/2022-03-06-ed25519-signatures.html).
54+
Plugin package signing is done using [Ed25519 public-key signatures](https://cendyne.dev/posts/2022-03-06-ed25519-signatures.html).
5555
:::
5656

5757
### Generate the Private Key
@@ -99,9 +99,10 @@ The file `public.pem` will contain the following format:
9999
Now that your repository and key-pair are ready, it’s time to create a release!
100100

101101
1. [Create a Github Action Secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) called `PRIVATE_KEY` with the content of the private key generated in [step 3](#3-generate-a-key-pair).
102+
1. [Enable release immutability](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases) in the repository General settings.
102103
1. Go to the `Actions` tab of your repository and trigger the `Release` workflow.
103104

104-
This will create a release with the version specified in your project's [caido.config.ts](/guides/config#version) file.
105+
This will create an immutable release with the version specified in your project's [caido.config.ts](/guides/config#version) file.
105106

106107
<img width="800" alt="Store release Github Workflow" src="/_images/store_release.png" center/>
107108

0 commit comments

Comments
 (0)