Skip to content

Commit 5feb414

Browse files
authored
Update getting_started.rst for tag-based releases (#440)
1 parent 2641543 commit 5feb414

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

doc/changes/unreleased.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
# Unreleased
2+
3+
## 📚 Documentation
4+
* Updated getting_started.rst for allowing tag-based releases

doc/user_guide/getting_started.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,22 @@ forward, and you just can use the example *noxfile.py* below.
184184
Within the `gh-pages.yml`, we use the GitHub `upload-pages-artifact` and `deploy-pages`
185185
actions. In order to properly deploy your pages, you'll need to reconfigure the GitHub
186186
Pages settings for the repo:
187+
187188
1. Go to the affected repo's GitHub page
188189
2. Select 'Settings'
189190
3. Scroll down & select 'Pages'
190191
4. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'.
191192

193+
We also need to configure settings for github-pages environment:
194+
195+
1. Go to the affected repo's GitHub page
196+
2. Select 'Settings'
197+
3. Scroll down & select 'Environment'
198+
4. Click on 'github-pages'
199+
5. In the 'Deployment branches and tags', click 'Add deployment branch or tag rule'
200+
6. Select 'Ref type' to be 'Tag' and set the 'Name pattern' to `[0-9]*.[0-9]*.[0-9]*` (or whatever matches that repo's tags)
201+
202+
192203
8. Go 🥜
193204
+++++++++++++
194205
You are ready to use the toolbox. With *nox -l* you can list all available tasks.

0 commit comments

Comments
 (0)