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.

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

RELEASE.md causing syncing issues with documentation site #2805

Closed
marcelovilla opened this issue Oct 30, 2024 · 0 comments · Fixed by #2809
Closed

RELEASE.md causing syncing issues with documentation site #2805

marcelovilla opened this issue Oct 30, 2024 · 0 comments · Fixed by #2809
Assignees
Labels
area: documentation 📖 Improvements or additions to documentation type: release 🏷 Items related to Nebari releases

Comments

@marcelovilla
Copy link
Member

Context

We currently have a GHA workflow that takes the notes from the RELEASE.md file, and opens a PR against the https://github.com/nebari-dev/nebari-docs repo so new release notes get published on https://www.nebari.dev/docs/references/release/.

This was working fine until the last release, where prettier was complaining about the format of the notes and building the website was not working because of invalid characters.

This was already taken care of on the docs side as a quick fix to get things working. However, it will fail the next time we do a release as it's going to use the format from the RELEASE.md file. We need to update this file with the following changes:

Value and/or benefit

Users will benefit from this as release notes will be published promptly after a new release is cut.

Anything else?

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation type: release 🏷 Items related to Nebari releases
Projects
Development

Successfully merging a pull request may close this issue.

1 participant