Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 2.97 KB

File metadata and controls

67 lines (47 loc) · 2.97 KB
name Release
about Checklist for releases

Overview

This is a checklist for releases. This is filled in by both the releaser and the reviewer where necessary.

Update Documentation

$ tools/bin/mage ttiProto:hugoData
  • Copy generated files to lorawan-stack-docs with the following command:
$ cp api/ttn.lorawan.v3/*.yml /path/to/lorawan-stack-docs/doc/data/api/ttn.lorawan.v3/
$ cp api/tti.lorawan.v3/*.yml /path/to/lorawan-stack-docs/doc/data/api/tti.lorawan.v3/
$ go build -tags tti ./cmd/tti-lw-cli
  • Then export the CLI documentation using the following command:
$ HOME='$HOME' ./tti-lw-cli gen-yaml-doc -o /path/to/lorawan-stack-docs/doc/data/

Check (for reviewers)

  • A new section has been created in whats-new with the corresponding CHANGELOG from TheThingsIndustries/lorawan-stack. The title is the release version and the date is the release date.
  • The documentation version is up to date.
  • 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 file:
doc/data/ttn-lw-cli.yml
  • All generated documentation matches the version that is being released.