| name | about |
|---|---|
Release |
Checklist for releases |
This is a checklist for releases. This is filled in by both the releaser and the reviewer where necessary.
- Create a new release in the
whats-newsection and copy the release CHANGELOG from TheThingsIndustries/lorawan-stack. The title is the release version and the date is the release date. - Copy the contents of the latest UPGRADING.md from the lorawan-stack-aws to /getting-started/aws/ecs/changelog
- Remove empty sections from the created release file.
- Update the documentation version to match the current PATCH, if necessary (
3.${minor}.${patch}). Note that this previously included a "v" prefix and only included a minor, but the patch must be included or repository and CLI links will break, and no "v" should be prefixed. - To generate documentation, create a clone of TheThingsIndustries/lorawan-stack, and checkout the git tag of the release.
- To generate API documentation, run the following from within the clone of TheThingsIndustries/lorawan-stack:
$ tools/bin/mage ttiProto:hugoData- Copy generated files to
lorawan-stack-docsby running the following commands inlorawan-stack-docs:
$ rsync --recursive --delete --remove-source-files ../lorawan-stack/api/ttn.lorawan.v3/ ./doc/data/api/ttn.lorawan.v3/
$ rsync --recursive --delete --remove-source-files ../lorawan-stack/api/tti.lorawan.v3/ ./doc/data/api/tti.lorawan.v3/NOTE: This assumes that the parent directory of
lorawan-stack-docsalso containslorawan-stack. If not, you'll need to adjust the commands accordingly.
- To generate and export CLI documentation from within the clone of TheThingsIndustries/lorawan-stack, first run the following command to build the CLI:
$ go build -tags tti ./cmd/tti-lw-cli- Then export the CLI documentation using following commands:
$ HOME='$HOME' ./tti-lw-cli gen-md-doc -o ../lorawan-stack-docs/doc/content/ttn-lw-cli$ HOME='$HOME' ./tti-lw-cli gen-json-tree -o ../lorawan-stack-docs/doc/data/commands- Replace links to
end-devices/templateswithtemplatesas they are not exported correctly:
$ sed -i.bak 's/end-devices_templates/templates/g' ../lorawan-stack-docs/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices.md- Clean up:
$ rm ../lorawan-stack-docs/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices.md.bakNOTE: This assumes that the parent directory of
lorawan-stack-docsalso containslorawan-stack. If not, you'll need to adjust the commands accordingly.
- A new section has been created in
whats-newwith the corresponding CHANGELOG from TheThingsIndustries/lorawan-stack. The title is the release version and the date is the release date. - The latest UPGRADING.md from the lorawan-stack-aws has been copied to /getting-started/aws/ecs/changelog
- The documentation version is up to date with the latest PATCH (
3.${minor}.${patch}). No "v" is prefixed. - The TTI and TTN API documentation has been generated and updated in doc/data/api. This includes the following files:
doc/data/api/tti.lorawan.v3/messages.yml
doc/data/api/tti.lorawan.v3/services.yml
doc/data/api/tti.lorawan.v3/enums.yml
doc/data/api/ttn.lorawan.v3/messages.yml
doc/data/api/ttn.lorawan.v3/services.yml
doc/data/api/ttn.lorawan.v3/enums.yml
- The TTI CLI documentation has been generated and updated in doc/data. This includes the following files:
doc/data/commands/ttn-lw-cli.json
doc/content/ttn-lw-cli/*.md
- All generated documentation matches the version that is being released.