Rundeck Documentation project.
- nodejs (Current LTS version is ok)
npm install
npm run docs:dev
npm run docs:build
Docs will be built and published to a base matching a branch name of
/3\.[1-9]\..*/:
- Branch
3.3.x=>docs.rundeck.com/3.3.x/ - Branch
3.3.1=>docs.rundeck.com/3.3.1/
Version tag must contain the full Rundeck version with date!
Tag a commit to publish to the matching version base as well as to the latest:
- Tag
v3.3.1-20200727=>docs.rundeck.com/3.3.1/ANDdocs.rundeck.com/docs/
For maintenance to docs on previous versions, simply create a branch:
# For 3.2.8
git checkout v3.2.8
git checkout -b 3.2.8
git push originRundeck Core PRs are included by default.
Core PRs can excluded by labeling them with the release-notes/exclude label.
Rundeck Enterprise PRs are excluded by default.
Enterprise PRs can be included by labeling them with the release-notes/include label.
Create the file .env in the project root and add the line GH_API_TOKEN=[TOKEN]
replacing [TOKEN] with your GitHub API token. This token needs repo scope.
Run the following with the milestone for the release:
npm run notes -- --milestone=3.3.9Draft Run the following with the milestone for the release:
npm run notes -- --milestone=3.3.9 --draft