Skip to content

Commit 2866855

Browse files
committed
docs: improve secret configuration steps #147
1 parent 82e0b4c commit 2866855

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ This guide will help you quickly configure a new repository from this template f
1919
### 🔑 2. Tokens and Secrets Configuration
2020

2121
You need to set up two tokens: the **GitHub** token (`PAT_TOKEN`) and the **Codacy** token (`CODACY_PROJECT_TOKEN`).
22+
Both tokens must be added to **Actions** and **Dependabot** secrets.
2223

2324
#### A. 🐙 Personal Access Token (PAT)
2425

@@ -28,9 +29,8 @@ The `PAT_TOKEN` is necessary for GitHub Actions (like Dependabot and year update
2829
* Go to **[Personal access tokens (classic)](https://github.com/settings/tokens)**.
2930
* If you don't have a token named `PAT_TOKEN` (or similar), click **Generate New Token**, select the `repo` scope, and **copy the generated token**.
3031
* If an existing `PAT_TOKEN` is close to expiring, click on it, select **regenerate the token**, and **copy the new value**.
31-
2. **Add the PAT to the new repository:**
32-
* Go to **Settings / Secrets and variables / Actions**.
33-
* Create a new repository secret: **Name:** `PAT_TOKEN`, **Secret:** *\[Your Token]*
32+
2. Go to **Settings / Secrets and variables**.
33+
3. Add the Secret under the name `PAT_TOKEN` both at **Actions** and **Dependabot secrets**.
3434

3535
#### B. 🛡️ Codacy Project Token
3636

@@ -39,13 +39,8 @@ Required to send code coverage reports.
3939
1. **Get the Codacy Token:**
4040
* Go to [Codacy](https://app.codacy.com) and **add your new repository**.
4141
* Open **Settings / Coverage** and **copy** the `CODACY_PROJECT_TOKEN` value.
42-
2. **Add the Secret (x2):** You need to add the token in **two** locations.
43-
* **Actions:** Go to **Settings / Secrets and variables / Actions**.
44-
* Create a new secret: **Name:** `CODACY_PROJECT_TOKEN`, **Secret:** *\[Codacy Token]*
45-
* **Dependabot:** Go to **Settings / Secrets and variables / Dependabot secrets**.
46-
* Create a new secret: **Name:** `CODACY_PROJECT_TOKEN`, **Secret:** *\[Codacy Token]*
47-
48-
> 💡 **Note:** Setting the secret for Dependabot is crucial to prevent automated Pull Requests from failing the coverage report job.
42+
2. Go to **Settings / Secrets and variables**.
43+
3. Add the Secret under the name `CODACY_PROJECT_TOKEN` both at **Actions** and **Dependabot secrets**.
4944

5045
### 📅 3. Year Update
5146

0 commit comments

Comments
 (0)