What & Why
Currently, our documentation builds on every code change. This means it might show unreleased features. We want docs to only update when we publish a new release, so they always match what users have installed.
What You'll Do
Edit the GitHub Actions workflow file that builds documentation (likely in .github/workflows/).
Change the trigger from:
on:
push:
branches: [main]To:
on:
release:
types: [published]Step-by-Step
- Find the workflow file (probably named something like
docs.yml or documentation.yml in .github/workflows/)
- Locate the
on: section at the top
- Replace it with the release trigger shown above
- Commit and push the change
- The workflow won't run immediately anymore - it will only run when a release is published
How to Test
- Publish a test release (or draft release) on GitHub
- Check the "Actions" tab to see if the workflow ran
- Verify the docs were updated
Success Looks Like
- ✅ Workflow no longer runs on regular commits
- ✅ Workflow runs when a release is published
- ✅ Documentation updates after release
Resources
What & Why
Currently, our documentation builds on every code change. This means it might show unreleased features. We want docs to only update when we publish a new release, so they always match what users have installed.
What You'll Do
Edit the GitHub Actions workflow file that builds documentation (likely in
.github/workflows/).Change the trigger from:
To:
Step-by-Step
docs.ymlordocumentation.ymlin.github/workflows/)on:section at the topHow to Test
Success Looks Like
Resources