My Workflow
In the recent years, lot of Python packages moved their documentation pipelines from third party services like ReadTheDocs to GitHub Pages, but some useful features were missing in the process.
This workflow intends to be a full featured replacement for RTD on GitHub Actions, giving back the control of the documentation deployment process to developers.
Features:
- Support of
pip
andconda
dependency files. - Build and deploy branches under
/branches/<branch>
. - Build and deploy tags under
/tags/<tag>
- Secure build and preview of pull requests under
/pull/<number>
via labels. - Manual trigger for branches.
- Select branch to deploy the site (default:
gh-pages
). - Redirect the main domain to
/latest
or/stable
(default:/latest
). - Redirect the
/stable
subdomain to the latest SemVer tag, or thestable
branch (if exists). - Automatic removal of pages from closed/merged pull requests, and deleted branches or tags.
Not supported:
Multi-language builds.
Live demo:
- https://epassaro.github.io/actions-rtd-workflow
- https://epassaro.github.io/actions-rtd-workflow/latest
- https://epassaro.github.io/actions-rtd-workflow/stable
- https://epassaro.github.io/actions-rtd-workflow/pull/1
- https://epassaro.github.io/actions-rtd-workflow/tag/v0.1.0
Submission Category:
DIY Deployments
Yaml File or Link to Code
epassaro / actions-rtd-workflow
A RTD-like documentation pipeline for GitHub Actions
actions-rtd-workflow
A RTD-like documentation pipeline for GitHub Actions
Features
- Support of
pip
andconda
dependency files. - Build and deploy branches under
/branches/<branch>
. - Build and deploy tags under
/tags/<tag>
. - Secure build and preview of pull requests under
/pull/<number>
via labels. - Manual trigger for branches.
- Select branch to deploy the site (default:
gh-pages
). - Redirect the main domain to
/latest
or/stable
(default:/latest
). - Redirect the
/stable
subdomain to the latest SemVer tag, or the stable branch (if exists). - Automatic removal of pages from closed/merged pull requests, and deleted branches or tags.
Not supported
Multi-language builds.
Top comments (0)