diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md index 79e701b84..b5716a1e2 100644 --- a/doc/changes/unreleased.md +++ b/doc/changes/unreleased.md @@ -1 +1,4 @@ # Unreleased + +## 📚 Documentation +* Updated getting_started.rst for allowing tag-based releases \ No newline at end of file diff --git a/doc/user_guide/getting_started.rst b/doc/user_guide/getting_started.rst index 0dbf48231..f00f15c22 100644 --- a/doc/user_guide/getting_started.rst +++ b/doc/user_guide/getting_started.rst @@ -184,11 +184,22 @@ forward, and you just can use the example *noxfile.py* below. Within the `gh-pages.yml`, we use the GitHub `upload-pages-artifact` and `deploy-pages` actions. In order to properly deploy your pages, you'll need to reconfigure the GitHub Pages settings for the repo: + 1. Go to the affected repo's GitHub page 2. Select 'Settings' 3. Scroll down & select 'Pages' 4. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'. +We also need to configure settings for github-pages environment: + +1. Go to the affected repo's GitHub page +2. Select 'Settings' +3. Scroll down & select 'Environment' +4. Click on 'github-pages' +5. In the 'Deployment branches and tags', click 'Add deployment branch or tag rule' +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) + + 8. Go 🥜 +++++++++++++ You are ready to use the toolbox. With *nox -l* you can list all available tasks.