You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/guides/repository.md
+13-5Lines changed: 13 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,16 @@ The steps above will create a repository under your own account.
44
44
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).
45
45
:::
46
46
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
48
57
49
58
Plugin packages **must** be digitally signed to be installable in Caido.
50
59
@@ -94,13 +103,12 @@ The file `public.pem` will contain the following format:
94
103
-----END PUBLIC KEY-----
95
104
```
96
105
97
-
## 4. Create a Release
106
+
## 5. Create a Release
98
107
99
108
Now that your repository and key-pair are ready, it’s time to create a release!
100
109
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.
104
112
105
113
This will create an immutable release with the version specified in your project's [caido.config.ts](/guides/config#version) file.
0 commit comments