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

docs(release): add information on how we tag and release #5392

Merged
merged 5 commits into from
Oct 19, 2022
Merged

Conversation

gustavovalverde
Copy link
Member

Motivation

We want to document the process we decided for audits and new features. We also want to write down the goals we're trying to satisfy.

Closes #5259

Solution

Improve the documentation from our Zebra versioning and releases

Review

This is a draft for revision. I started a whole document but then I realized I was repeating most of the information already available in the Release process and the release checklist

As @arya2 and @teor2345 recently made the first release candidate, they might have more fresh ideas to add here.

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?

@gustavovalverde gustavovalverde added A-docs Area: Documentation C-enhancement Category: This is an improvement P-Low ❄️ labels Oct 12, 2022
@github-actions github-actions bot added the C-feature Category: New features label Oct 12, 2022
Copy link
Contributor

@teor2345 teor2345 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!

We talked about audit tags and audit branches, but they aren't mentioned in this document.
Can you add a short section based on what we decided in the meeting:

  • we'll give the latest rc tag to the auditors to review
  • when we get the audit report, if the auditors want to review a separate branch with just the audit fixes, we'll make a branch from the audit tag, and make fixes there

book/src/dev/release-process.md Outdated Show resolved Hide resolved
book/src/dev/release-process.md Outdated Show resolved Hide resolved
book/src/dev/release-process.md Outdated Show resolved Hide resolved
book/src/dev/release-process.md Outdated Show resolved Hide resolved
@gustavovalverde gustavovalverde marked this pull request as ready for review October 18, 2022 20:49
@gustavovalverde gustavovalverde requested a review from a team as a code owner October 18, 2022 20:49
@gustavovalverde gustavovalverde requested review from oxarbitrage and removed request for a team October 18, 2022 20:49
@teor2345
Copy link
Contributor

@gustavovalverde did you want help with the audit part, or did you want to do that in a separate PR?

@gustavovalverde
Copy link
Member Author

@gustavovalverde did you want help with the audit part, or did you want to do that in a separate PR?

I created a ticket for the specific audit part #5431

@teor2345
Copy link
Contributor

teor2345 commented Oct 19, 2022

@gustavovalverde did you want help with the audit part, or did you want to do that in a separate PR?

I created a ticket for the specific audit part #5431

Fair enough, I think that will also be partly covered by #5395, which mentions the audit tag and dependencies.

Copy link
Contributor

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

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

Thanks!

mergify bot added a commit that referenced this pull request Oct 19, 2022
@mergify mergify bot merged commit 65e9822 into main Oct 19, 2022
@mergify mergify bot deleted the docs-branching branch October 19, 2022 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation C-enhancement Category: This is an improvement C-feature Category: New features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write up how we want to do tags and feature branches
3 participants