Skip to content

Commit 9315e14

Browse files
committed
fix(docs): made check secrets an explicit step in semver-workflow readme
1 parent f454246 commit 9315e14

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/semver-workflow.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,16 @@ on:
2626
branches: [main, v3]
2727
```
2828
29-
** Check secrets **
29+
### 3. Check secrets
3030
Ensure that your repo or Github org has set the secrets used by the workflow.
3131
3232
`secrets.GITHUB_TOKEN` should always be available by default, but
33-
`secrets.NPM_PUBLISH_TOKEN` is not.
33+
`secrets.NPM_PUBLISH_TOKEN` is not.
3434

35-
### 3. Update .releaserc.json
35+
Secrets can be set using `Settings -> Secrets -> Actions -> "New reposiotry secret"`
36+
on Github for a repository.
37+
38+
### 4. Update .releaserc.json
3639

3740
This differs from repo to repo. Branches defaults to `"branches": ["main"]`
3841

@@ -48,7 +51,7 @@ In a typical plugin repo with a v2 and v3 version, it will typically look like t
4851
This assumes that the v2 version lives on `main` and the v3 versions livs on `v3`.
4952
The v3 version will be a pre-release using `studio-v3` as npm tag, and `v3-studio` version suffix.
5053

51-
## 4. Test workflow and remove `--dry-run`
54+
### 5. Test workflow and remove `--dry-run`
5255

5356
The injected semantic-release command in `.github/workflows/main.yml` has `--dry-run` enabled.
5457

0 commit comments

Comments
 (0)