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

change(doc): Update README and release checklist for the release candidate #5314

Merged
merged 13 commits into from
Oct 5, 2022

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Oct 3, 2022

Motivation

We want to change how we tag and release the release candidate.

Dependencies

The README and release checklist Docker instructions won't work until we fix:

Solution

  • Update the README for the release candidate
    • Update goals
    • Add a docker run command
  • Update the release template for the release candidate
    • Update process to match what we currently do
    • Use the docker run command from the README for testing

Fix #4953
Fix #4954

Review

I think Pili wanted to review this, but other engineers might want to as well.

Reviewer Checklist

  • Will the PR name make sense to users?
    • Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
  • Are the PR labels correct?
  • Does the code do what the ticket and PR says?
  • How do you know it works? Does it have tests?

Follow Up Work

@teor2345 teor2345 added A-docs Area: Documentation A-devops Area: Pipelines, CI/CD and Dockerfiles C-enhancement Category: This is an improvement P-Medium ⚡ labels Oct 3, 2022
@teor2345 teor2345 requested a review from mpguerra October 3, 2022 03:07
@teor2345 teor2345 requested a review from a team as a code owner October 3, 2022 03:07
@teor2345 teor2345 self-assigned this Oct 3, 2022
@teor2345 teor2345 requested review from upbqdn and removed request for a team October 3, 2022 03:07
@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label Oct 3, 2022
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@mpguerra mpguerra left a comment

Choose a reason for hiding this comment

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

Looks good overall, I think we may need to finalise some details before we can publish though

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
teor2345 and others added 4 commits October 4, 2022 06:04
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Contributor

@mpguerra mpguerra left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@gustavovalverde gustavovalverde left a comment

Choose a reason for hiding this comment

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

LGTM

mergify bot added a commit that referenced this pull request Oct 5, 2022
@mergify mergify bot merged commit fd63d33 into main Oct 5, 2022
@mergify mergify bot deleted the rc-release-checklist branch October 5, 2022 12:46
@teor2345 teor2345 mentioned this pull request Oct 11, 2022
32 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-devops Area: Pipelines, CI/CD and Dockerfiles A-docs Area: Documentation C-enhancement Category: This is an improvement C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG
Projects
None yet
3 participants