Skip to content

Commit 95a3317

Browse files
committed
doc: Update release template
1 parent 0590a67 commit 95a3317

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

.github/ISSUE_TEMPLATE/release.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This is a checklist for releases. This is filled in by both the releaser and the
1515

1616
#### Update Documentation
1717

18+
- [ ] Create a new release in the [`whats-new` section](doc/content/whats-new) and copy the release CHANGELOG from [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack). The title is the release version and the date is the release date.
1819
- [ ] Update the [documentation version](https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/config/_default/config.toml#L28) to match the current minor, if necessary (`v3.${minor}`).
1920
- [ ] To generate documentation, create a clone of [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack), and **checkout the git tag of the release**.
2021
- [ ] To generate API documentation, run the following from within the clone of [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack):
@@ -41,13 +42,14 @@ $ go build -tags tti ./cmd/tti-lw-cli
4142
- [ ] Then export the CLI documentation using the following command:
4243

4344
```bash
44-
$ HOME='$HOME' ./tti-lw-cli gen-yaml-doc -o ../lorawan-stack-docs/doc/data/
45+
$ HOME='$HOME' ./tti-lw-cli gen-yaml-doc -o /path/to/lorawan-stack-docs/doc/data/
4546
```
4647

4748
> NOTE: Replace `../lorawan-stack-docs` if your `lorawan-stack-docs` folder is in a different location.
4849
4950
#### Check (for reviewers)
5051

52+
- [ ] A new section has been created in [`whats-new`](doc/content/whats-new) with the corresponding CHANGELOG from [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack). The title is the release version and the date is the release date.
5153
- [ ] The documentation version is up to date.
5254
- [ ] The TTI and TTN API documentation has been generated and updated in [doc/data/api](https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/data/api). This includes the following files:
5355

doc/content/whats-new/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
22
title: "Release Notes"
33
description: ""
4-
---
4+
---

0 commit comments

Comments
 (0)