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

Add version and changelog files #104

Closed

Conversation

tanjadegroot
Copy link
Collaborator

What type of PR is this?

Add one of the following kinds:

  • documentation

What this PR does / why we need it:

Adds a VERSION.md file for versioning of the Release Mgmt artifacts.
Adds a CHANGELOG.md file for tracking the changes to the Release Mgmt artifacts per release.

Which issue(s) this PR fixes:

It contributes to preparing the r1.1

Fixes #97

Copy link

linux-foundation-easycla bot commented Oct 2, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@hdamker
Copy link
Collaborator

hdamker commented Oct 2, 2024

@tanjadegroot I created a draft release for r1.1. There you can find also the auto-generated list of PRs which went into it.

Steps I used to created it: https://github.com/orgs/community/discussions/23535#discussioncomment-3240768

Comment on lines +22 to +25
* Add API-Readiness-Checklist.md to RM project by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/29
* Add API Release Guidelines to GitHub - extract of the API Release Pro… by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/31
* Update public release name by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/35
* Update readme.md and further links in rm project material by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/42
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the auto-generated changelist from GitHub:

Suggested change
* Add API-Readiness-Checklist.md to RM project by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/29
* Add API Release Guidelines to GitHub - extract of the API Release Pro… by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/31
* Update public release name by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/35
* Update readme.md and further links in rm project material by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/42
* Add API-Readiness-Checklist.md to RM project by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/29
* Add API Release Guidelines to GitHub - extract of the API Release Pro… by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/31
* Added changelog template and example by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/36 and @hdamker in https://github.com/camaraproject/ReleaseManagement/pull/38
* Update public release name by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/35

#42 was merged end of July.

Updated links to refer to r1.1. Please check if ok.
@hdamker hdamker changed the base branch from main to temp-r1.1 October 2, 2024 23:46
@hdamker hdamker requested a review from a team as a code owner October 2, 2024 23:46
@hdamker hdamker changed the base branch from temp-r1.1 to main October 2, 2024 23:47
@hdamker
Copy link
Collaborator

hdamker commented Oct 8, 2024

@tanjadegroot My suggestion would be to close this PR and create a new one with only the content of the proposed CHANGELOG and create the release then on the temp-r1.1 branch. I can take that if you prefer.

@tanjadegroot
Copy link
Collaborator Author

OK to close this PR, as obsolete by now.

@tanjadegroot tanjadegroot deleted the Add-version-and-changelog-files branch October 11, 2024 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create the release r1.1 of the RM documentation
2 participants