Skip to content

Commit ed5f4e2

Browse files
committed
docs: improve housekeeping documentation
1 parent 23d773a commit ed5f4e2

File tree

1 file changed

+33
-10
lines changed

1 file changed

+33
-10
lines changed

README.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,37 @@
11
# Advent of Code {year}
22

3-
## How to create a repository from this template repository
3+
## Housekeeping
4+
5+
Before creating a new repository from this template, perform the following steps.
6+
7+
### Personal Access Token Setup
8+
9+
Open **[Personal access tokens (classic)](https://github.com/settings/tokens)** settings and verify if there is any
10+
``PAT_TOKEN`` or if it is nearly to expire.
11+
12+
#### Creation of a new token
13+
14+
If there is no ``PAT_TOKEN`` created:
15+
16+
1. Click on **Generate New Token**.
17+
2. Select ``repo`` checkbox.
18+
3. Copy the token.
19+
20+
#### Refresh of an existing token
21+
22+
If there is an existing ``PAT_TOKEN``:
23+
24+
1. Click on it.
25+
2. If the expiration date is due soon, click on **regenerate the token**.
26+
3. Update the ``PAT_TOKEN`` at this template repository.
27+
28+
### Update dependencies
29+
30+
Before creating a new repository using this template, **review and merge any pending pull requests**.
31+
32+
## New repository creation
33+
34+
Follow this steps after housekeeping is finished.
435

536
### Creation
637

@@ -11,15 +42,7 @@
1142

1243
### Personal Access Token Setup
1344

14-
In order to the GitHub Actions to be able to perform certain actions, a **Personal Access Token** is needed:
15-
1. Open **Account / Settings / Developer Settings**.
16-
2. Click on **Generate New Token**.
17-
3. Select ``repo`` checkbox.
18-
4. Copy the token.
19-
5. Open the created repository.
20-
6. Open **Settings / Secrets and variables / Actions** and click on **New repository secret**:
21-
1. **Name:** ``PAT_TOKEN``
22-
2. **Secret:** The previously copied token.
45+
Add the previously mentioned ``PAT_TOKEN`` to this new repository.
2346

2447
### Codacy Project Token Setup
2548

0 commit comments

Comments
 (0)