Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe how to release the doc repo. #157

Merged
merged 3 commits into from
May 2, 2024
Merged

Describe how to release the doc repo. #157

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b0be60
Describe how to release the doc repo.
roehrich-hpe May 1, 2024
a27eb50
Update docs/repo-guides/release-nnf-sw/readme.md
roehrich-hpe May 2, 2024
3625d2f
Update docs/repo-guides/release-nnf-sw/readme.md
roehrich-hpe May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/repo-guides/release-nnf-sw/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,16 @@ that everything is current on `master` for `nnf-deploy`.

12. Follow steps 6-7 from the previous section to finalize the release of `nnf-deploy`.

**Please review documenation for changes you may have made**
## Release `NearNodeFlash.github.io`

**Please review and update the documentation for changes you may have made.**

After nnf-deploy has a release tag you may release the documentation. Use the same steps found above in "Release Each Component". Note that the default branch for this repo is "main" instead of "master".
roehrich-hpe marked this conversation as resolved.
Show resolved Hide resolved

Give this release a tag that matches the nnf-deploy release, to show that they go together. Create the release by using the "Create release" or "Draft a new release" button in the GUI, or by using the `gh release create` CLI command. Whether using the GUI or the CLI, mark the release as "latest" and select the appropriate option to generate release notes.

Wait for the `mike` tool in .github/workflow/release.yaml to finish building the new doc. You can check its status by going to the `gh-pages` branch in the repo. When you visit the release at [https://nearnodeflash.github.io](https://nearnodeflash.github.io) you should see the new release in the drop-down menu and the new release should be the default display.
roehrich-hpe marked this conversation as resolved.
Show resolved Hide resolved

**The software is now released!**

## Clone a release
Expand Down
Loading