@@ -13,34 +13,18 @@ Doing a **_Release_** or **Hotfix** is a two-step process. The first part is com
...
@@ -13,34 +13,18 @@ Doing a **_Release_** or **Hotfix** is a two-step process. The first part is com
We render release notes from the `CHANGELOG.md` so it is important that the file has all the relevant information for each release. These are displayed via a Pop Up in Foundry after a Migration has happened which we assume will happen for every release.
We render release notes from the `CHANGELOG.md` so it is important that the file has all the relevant information for each release. These are displayed via a Pop Up in Foundry after a Migration has happened which we assume will happen for every release.
#### Update the Date of the Release
:information_source: Make sure to use the `YYYY-MM-DD` format for the date.
From:
```markdown
## Version 0.84.0 | Date: WIP
```
To:
```markdown
## Version 0.84.0 | Date: 2022-12-30
```
#### Actions Needed
#### Actions Needed
If actions need to be taken by the GM or players after doing an update, the release popup should document them.
If actions need to be taken by the GM or players after doing an update, the release popup should document them.
To do this add a section to the `CHANGELOG.md` called `Release Specific Instructions` as a section under the `Version...` heading. Ideally these instructions should be added in the same MR as the change that requires the special instructions.
To do this add a section to the `CHANGELOG.md` called `Action Needed` as a section under the `Version...` heading. Ideally these instructions should be added in the same MR as the change that requires the special instructions.
