Repository navigation
chore: add changelog generation workflow and initial changelog files - #8
Merged
Merged
Conversation
Awesome-Ace22
added
documentation
Awesome-Ace22
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant improvements to documentation, onboarding, and release process automation for the NovaOps backend. It adds a changelog generation workflow, a generated
CHANGELOG.md, and acliff.tomlconfiguration for changelog formatting. TheREADME.mdand documentation files have been rewritten for clarity, with new guides on environment variables and tool usage, and improved onboarding instructions for contributors.Release automation and changelog:
.github/workflows/changelog.ymlto automate changelog generation and PR creation using git-cliff and the create-pull-request action.CHANGELOG.md, generated by git-cliff, to document changes per Nova release.cliff.tomlconfiguration to control changelog formatting and commit grouping.Documentation and onboarding improvements:
README.mdto provide a clearer overview, onboarding steps, troubleshooting, and links to further documentation.docs/environment.mdto document all environment variables used by the backend and FAS bridge.docs/index.md.CONTRIBUTING.mdwith clearer instructions on where to work and improved links to testing procedures. [1] [2]