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

Prepare release r1.2 #91

Merged
merged 8 commits into from
Aug 7, 2024
Merged

Prepare release r1.2 #91

merged 8 commits into from
Aug 7, 2024

Conversation

hdamker
Copy link
Contributor

@hdamker hdamker commented Aug 6, 2024

What type of PR is this?

Add one of the following kinds:

  • documentation
  • subproject management

What this PR does / why we need it:

This is the release PR for r1.2.

  • Update of CHANGELOG.md

    • Moved new release to top
    • Applied the CHANGELOG.md template to r1.2
    • Replaced links to issues with links to PRs
    • Removed formal changes which are not relevant for API users
  • Update Call_Forwarding_Signal.yaml

    • Removed comments from Design Guidelines (not meant to be in the YAML)
    • Updated x-camara-commonalities to the current available version
    • Updated version and server url for rc.2
    • Aligned server URL description with latest Commonalities guideline
  • Deleted obsolete README.md in API_Definitions

  • Cosmetic change within call-forwarding-signal-API-Readiness-Checklistst.md

Which issue(s) this PR fixes:

Fixes #72 #90

Special notes for reviewers:

The PR should be merged only after all issues within scope of #72 are resolved (especially #90) and after the PR got an approval by one of @camaraproject/release-management_maintainers. The merge commit of this PR will get tagged as the release r1.2.

Moved new release to top
Applied the CHANGELOG.md template to r1.2
Replaced links to issues with links to PRs
Removed formal changes which are not relevant for API users
Removed comments from Design Guidelines (not meant to be in the YAML)
Updated x-camara-commonalities to the current available version
Updated version and server url
Aligned server URL description with latest Commonalities guideline
Deleted obsolete file
@hdamker hdamker linked an issue Aug 6, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Aug 6, 2024

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.03s
✅ OPENAPI spectral 1 0 1.69s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY secretlint yes no 0.72s
✅ YAML yamllint 1 0 0.33s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

CHANGELOG.md Outdated Show resolved Hide resolved
@FabrizioMoggio
Copy link
Collaborator

@hdamker Just one question about this sentence:

"Special notes for reviewers:
The PR should be merged only after all issues within scope of #72 are resolved (especially #90) and after the PR got an approval by one of @camaraproject/release-management_maintainers. The merge commit of this PR will get tagged as the release r1.2."

and especially on this section:

"The merge commit of this PR will get tagged as the release r1.2."

My problem is that in this PR the version is still: wip. I can not create a Release Tag.

In my understanding the sequence is:

  1. update your commit with the requested modifications (e.g. the Auth section text). The YAML still has version: wip
  2. review and approve the PR by coworkers and release-management_maintainers. Still wip
  3. merge the PR
  4. create a new PR with just one modification, the version: v0.2.0-rc.2
  5. approve the PR
  6. merge the PR
  7. create the Release Tag

is this sequence correct?

hdamker and others added 2 commits August 7, 2024 09:36
Set version and server url to the correct values for the second release candidate.
info.description: updated the "Authorization and authentication" section according to: #90
FabrizioMoggio
FabrizioMoggio previously approved these changes Aug 7, 2024
Copy link
Collaborator

@FabrizioMoggio FabrizioMoggio left a comment

Choose a reason for hiding this comment

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

LGTM

@FabrizioMoggio FabrizioMoggio added Fall24 documentation Improvements or additions to documentation labels Aug 7, 2024
CHANGELOG.md Show resolved Hide resolved
@hdamker
Copy link
Contributor Author

hdamker commented Aug 7, 2024

@FabrizioMoggio You have already seen by 0b0b2f3 that I just missed to change the version: wip.

My intention was:

In my understanding the sequence is:

  1. update your commit with the requested modifications (e.g. the Auth section text). The YAML still has version: wip

The change of the Auth section could have done also in a dedicated PR for the issue (which would have been merged before this one here). But I'm also fine with your commit 3b72d16 here. I updated the PR description ("Fixes ...") and the CHANGELOG.md.

  1. review and approve the PR by coworkers and release-management_maintainers. Still wip

Yes, and this is the release PR, hence it does the change to v0.2.0-rc.2

  1. merge the PR
    > 4. create a new PR with just one modification, the version: v0.2.0-rc.2
    > 5. approve the PR
    > 6. merge the PR
  2. create the Release Tag

Copy link
Collaborator

@FabrizioMoggio FabrizioMoggio left a comment

Choose a reason for hiding this comment

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

OK

@FabrizioMoggio
Copy link
Collaborator

I think that everything is fixed. Waiting for a final approval by @camaraproject/release-management_maintainers before merging.

Copy link
Collaborator

@chinaunicomyangfan chinaunicomyangfan left a comment

Choose a reason for hiding this comment

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

LGTM

@hdamker hdamker requested review from a team and removed request for tanjadegroot and soadeyemo August 7, 2024 10:19
Copy link
Collaborator

@rartych rartych left a comment

Choose a reason for hiding this comment

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

LGTM

@hdamker
Copy link
Contributor Author

hdamker commented Aug 7, 2024

I think that everything is fixed. Waiting for a final approval by @camaraproject/release-management_maintainers before merging.

@FabrizioMoggio You are good to go ... I just asked @rartych for final view on the PR from release management perspective (as I didn't wanted to approve my own PR).

@FabrizioMoggio FabrizioMoggio merged commit 7fe0355 into main Aug 7, 2024
1 check passed
@hdamker hdamker deleted the 72-create-release-r12 branch August 7, 2024 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Fall24
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Scope for RC.2 for Meta Release Fall 24
4 participants