Rundeck Documentation project.
- NodeJS (lts/erbium or version 12 is currently best)
Recommended setup steps
nvm to manage your NodeJS installations.
nvm install lts/erbium; nvm use lts/erbium to install and set the NodeJS version.
Run this before the first you start the docs site locally.
Run the Rundeck Docs site locally
npm run docs:dev
Compiles and hot-reloads for development. As (most) content changes are made they show up immediately. Changes to the menus will require quitting and restarting with the command above.
Running in Production
Compiles and minifies for production.
npm run docs:build
Rundeck welcomes documentation PRs. Please submit PRs against the default branch (currently
3.3.x) and we will review.
Docs will be built and published to a base matching a branch name of
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:
git tag -f v3.3.9-20210201 git push -f origin v3.3.9-20210201
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 origin
Generating Release Notes
Rundeck Core PRs are included by default.
Core PRs can excluded by labeling them with the
Rundeck Enterprise PRs are excluded by default.
Enterprise PRs can be included by labeling them with the
Create the file
.env in the project root and add the line
[TOKEN] with your GitHub API token. This token needs
Run the following with the milestone for the release. This will create/overwrite an existing entry for the release. Use wisely:
npm run notes -- --milestone=3.3.9
Draft Run the following with the milestone for the release. This will create the file named draft.md to avoid overwriting any existing version:
npm run notes -- --milestone=3.3.9 --draft