Skip to content

Commit d401d9c

Browse files
committed
NEWS: move to docs
Since the release notes are in Markdown now, let's add them to the docs site. Add a symlink from the root to make them easier to find in a tarball or checkout.
1 parent bf66f76 commit d401d9c

File tree

4 files changed

+344
-339
lines changed

4 files changed

+344
-339
lines changed

.github/ISSUE_TEMPLATE/release-checklist.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Release checklist:
22

33
Tagging:
4-
- [ ] Write release notes in `NEWS.md`. Get them reviewed and merged
5-
- [ ] If doing a branched release, also include a PR to merge the `NEWS.md` changes into main
4+
- [ ] Write release notes in `docs/release-notes.md`. Get them reviewed and merged
5+
- [ ] If doing a branched release, also include a PR to merge the `docs/release-notes.md` changes into main
66
- [ ] Ensure your local copy is up to date with the upstream main branch (`[email protected]:coreos/butane.git`)
77
- [ ] Ensure your working directory is clean (`git clean -fdx`)
88
- [ ] Ensure you can sign commits and any yubikeys/smartcards are plugged in
@@ -49,7 +49,7 @@ GitHub release:
4949
- [ ] Download the artifacts and signatures
5050
- [ ] Verify the signatures
5151
- [ ] Find the new tag in the [GitHub tag list](https://github.com/coreos/butane/tags) and click the triple dots menu, and create a draft release for it.
52-
- [ ] Upload all the release artifacts and their signatures. Copy and paste the release notes from `NEWS.md` here as well.
52+
- [ ] Upload all the release artifacts and their signatures. Copy and paste the release notes from `docs/release-notes.md` here as well.
5353
- [ ] If the signing key has changed, note the change in the GitHub release notes as done [here](https://github.com/coreos/butane/releases/tag/v0.12.0).
5454
- [ ] Publish the release
5555

NEWS.md

-335
This file was deleted.

NEWS.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/release-notes.md

docs/development.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
nav_order: 9
2+
nav_order: 10
33
---
44

55
# Developing Butane

0 commit comments

Comments
 (0)