Add VERSIONING.md and add kpt API as a component to README#4622
Open
mozesl-nokia wants to merge 1 commit into
Open
Add VERSIONING.md and add kpt API as a component to README#4622mozesl-nokia wants to merge 1 commit into
mozesl-nokia wants to merge 1 commit into
Conversation
Assisted-by: Cursor:composer-2.5 Signed-off-by: Mózes László Máté <laszlo.mozes@nokia.com>
mozesl-nokia
requested review from
efiacor,
kispaljr and
liamfallon
as code owners
dosubot
Bot
added
the
size:M
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
kushnaidu
approved these changes
Jul 6, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a repository versioning guide to document kpt’s release/tagging and compatibility expectations, and updates the main README to surface both the API module and the new versioning documentation.
Changes:
- Adds
VERSIONING.mddescribing kpt’s versioning approach, including separate CLI vs API module release tags. - Updates
README.mdto list theapimodule as a component and link to the versioning guide.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| VERSIONING.md | New versioning policy/guide (SemVer semantics, breaking changes, release surfaces). |
| README.md | Adds kpt API to the component list and links to the new versioning guide. |
Comments suppressed due to low confidence (1)
VERSIONING.md:60
[semver specification]is referenced earlier but not defined, resulting in a broken Markdown link. Add a reference definition alongside the existing[semantic versioning]link.
[semantic versioning]: https://semver.org/
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Added a versioning guide file to clarify how we differ slightly from official semver. Added a link to this file into the main README.
Additionally, the
apimodule was not added to the component list in the README, so I added that now as well.Used Cursor's composer-2.5 to generate the text in VERSIONING.md