Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 4.76 KB

File metadata and controls

91 lines (64 loc) · 4.76 KB
name about
Release
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 by running the following commands in lorawan-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-docs also contains lorawan-stack. If not, you'll need to adjust the commands accordingly.

$ 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/templates with templates as 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.bak

NOTE: This assumes that the parent directory of lorawan-stack-docs also contains lorawan-stack. If not, you'll need to adjust the commands accordingly.

Check (for reviewers)

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.