File: ADDING_RELEASE_DOCS.md

package info (click to toggle)
bnd 5.0.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 44,128 kB
  • sloc: java: 249,039; xml: 90,728; sh: 655; perl: 153; makefile: 96; python: 47; javascript: 9
file content (16 lines) | stat: -rw-r--r-- 482 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
## Adding Release Docs

* checkout the release tag
* edit `docs/_config.yml` setting the properties
  ```
  releasename: <version>
  baseurl: /releases/<version>
  ```
  replacing `<version>` for the actual version
* run `./build.sh`
* copy the generated contents of `docs/_site` into a temporary location
* checkout the master branch
* copy previously saved content into `docs/release/<version>`
* commit & push

**Note:** Make sure to leave `baseurl` unset in the `master` branch.