Merge pull request #26606 from backstage/mob/grab-release-notes

docs: Grab release notes from `mainline` before publishing
This commit is contained in:
Patrik Oldsberg
2024-09-13 18:29:43 +03:00
committed by GitHub
12 changed files with 579 additions and 580 deletions
+1 -1
View File
@@ -27,7 +27,7 @@ Records should be stored under the `architecture-decisions` directory.
- Address and integrate feedback from the community
- Eventually, assign a number
- Add the path of the ADR to the microsite sidebar in
[`sidebars.json`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.json)
[`sidebars.js`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.js)
- Add the path of the ADR to the
[`mkdocs.yml`](https://github.com/backstage/backstage/blob/master/mkdocs.yml)
- Merge the pull request
+1 -1
View File
@@ -39,7 +39,7 @@ the code.
- [`docs/`](https://github.com/backstage/backstage/tree/master/docs) - This is
where we keep all of our documentation Markdown files. These end up on
https://backstage.io/docs. Just keep in mind that changes to the
[`sidebars.json`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.json)
[`sidebars.js`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.js)
file may be needed as sections are added/removed.
- [`.editorconfig`](https://github.com/backstage/backstage/tree/master/.editorconfig) -
+1 -1
View File
@@ -51,7 +51,7 @@ Additional steps for the main line release
- Mention any security fixes
- Create Release Notes PR
- Add the release note file as [`/docs/releases/vx.y.0.md`](./releases)
- Add an entry to [`/microsite/sidebar.json`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.json) for the release note
- Add an entry to [`/microsite/sidebar.js`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.js) for the release note
- Update the navigation bar item in [`/microsite/docusaurus.config.ts`](https://github.com/backstage/backstage/blob/master/microsite/docusaurus.config.ts) to point to the new release note
- Finally copy the content, without the metadata header, into the description of the [`Version Packages` Pull Request](https://github.com/backstage/backstage/pulls?q=is%3Aopen+is%3Apr+in%3Atitle+%22Version+Packages)