Skip to content

Commit dae04f8

Browse files
authored
Add immutable releases to plugin instructions (#92)
1 parent fd6efb4 commit dae04f8

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

src/guides/repository.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,16 @@ The steps above will create a repository under your own account.
4444
If you would like to host your repository under the [caido-community](https://github.com/caido-community) organization instead, you can request a repository on our [Discord server](https://links.caido.io/www-discord).
4545
:::
4646

47-
## 3. Generate a Key-Pair
47+
## 3. Enable Immutable Releases
48+
49+
Before creating your release, you must enable immutable releases in your repository settings. Immutable releases prevent published releases from being modified or deleted, ensuring users always install the exact version that was reviewed and approved.
50+
51+
1. Go to your repository on GitHub
52+
2. Navigate to **Settings****General**
53+
3. Scroll down to the **Releases** section
54+
4. Enable **Immutable releases**
55+
56+
## 4. Generate a Key-Pair
4857

4958
Plugin packages **must** be digitally signed to be installable in Caido.
5059

@@ -94,13 +103,12 @@ The file `public.pem` will contain the following format:
94103
-----END PUBLIC KEY-----
95104
```
96105

97-
## 4. Create a Release
106+
## 5. Create a Release
98107

99108
Now that your repository and key-pair are ready, it’s time to create a release!
100109

101-
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.
103-
1. Go to the `Actions` tab of your repository and trigger the `Release` workflow.
110+
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 4](#4-generate-a-key-pair).
111+
2. Go to the `Actions` tab of your repository and trigger the `Release` workflow.
104112

105113
This will create an immutable release with the version specified in your project's [caido.config.ts](/guides/config#version) file.
106114

0 commit comments

Comments
 (0)