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

doc(release): Update release template for Docker releases #5193

Merged
merged 8 commits into from
Sep 27, 2022

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Sep 19, 2022

Motivation

  1. We're releasing Docker Hub binaries now, so we need to add a "publish the release" step
  2. The Cargo.lock description is confusing.
  3. Semantic versioning is explained on their website, so we don't need a detailed description in the release template.

This is the Docker part of #4954, we still need to do the rc part.

Solution

  • Make the release a pre-release until the Docker binaries have been built and tested
  • Explain that cargo build needs to be run
  • Delete a long description of semantic versioning
  • Fix a suggested branch name so it will work with Google Cloud

Review

This is a routine update.

I'll need @gustavovalverde to check the new Docker release steps.

Reviewer Checklist

  • Docs make sense

I always have to look this up every time.

Also delete a long description of semantic versioning.
@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 Sep 19, 2022
@teor2345 teor2345 self-assigned this Sep 19, 2022
@teor2345 teor2345 requested a review from a team as a code owner September 19, 2022 04:29
@teor2345 teor2345 requested review from dconnolly and removed request for a team September 19, 2022 04:29
@teor2345 teor2345 changed the title fix(release): Explain how to use the release template doc(release): Delete detailed explanation of semantic versioning from the release template Sep 19, 2022
@teor2345 teor2345 added C-cleanup Category: This is a cleanup P-Low ❄️ and removed A-devops Area: Pipelines, CI/CD and Dockerfiles C-enhancement Category: This is an improvement P-Medium ⚡ labels Sep 19, 2022
@teor2345 teor2345 changed the title doc(release): Delete detailed explanation of semantic versioning from the release template doc(release): Update and clean up release template Sep 19, 2022
@teor2345 teor2345 requested review from gustavovalverde and removed request for dconnolly September 19, 2022 06:25
@teor2345 teor2345 changed the title doc(release): Update and clean up release template doc(release): Update release template for Docker releases Sep 19, 2022
@teor2345
Copy link
Contributor Author

@Mergifyio update

@mergify
Copy link
Contributor

mergify bot commented Sep 27, 2022

update

✅ Branch has been successfully updated

@gustavovalverde
Copy link
Member

@Mergifyio update

@mergify
Copy link
Contributor

mergify bot commented Sep 27, 2022

update

❌ Base branch update has failed

merge conflict between base and head
err-code: B3618

@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label Sep 27, 2022
@mergify mergify bot merged commit 99bdc8d into main Sep 27, 2022
@mergify mergify bot deleted the release-template-updates branch September 27, 2022 21:53
@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-docs Area: Documentation C-cleanup Category: This is a cleanup C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants