Skip to content

chore(maintenance): update release flow diagram #2322

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

Merged
merged 7 commits into from
Apr 9, 2024

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR updates the content of the diagram that shows the release process in the maintainers handbook.

Before

image

After

image

Related issues, RFCs

Issue number: #2044

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Apr 5, 2024
@dreamorosi dreamorosi requested a review from a team April 5, 2024 12:52
@dreamorosi dreamorosi requested a review from a team as a code owner April 5, 2024 12:52
@dreamorosi dreamorosi linked an issue Apr 5, 2024 that may be closed by this pull request
1 task
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Apr 5, 2024
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Apr 5, 2024
@am29d am29d self-requested a review April 8, 2024 09:38
Copy link
Contributor

@am29d am29d left a comment

Choose a reason for hiding this comment

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

Thanks for detailed update on the visualisation. I was wondering if we should add manual PRs visually and the separation between version bump and release workflow. What do you think?

@dreamorosi
Copy link
Contributor Author

Hi, thanks for the review!

I have update the diagram to make the manual steps stand out more (converted them into milestones):
image

Regarding the separation of version & release I would leave it as a single section/diagram. I have however updated the description above to more explicitly call out that the release process is composed by multiple district workflows.

@dreamorosi dreamorosi requested a review from am29d April 9, 2024 06:38
Copy link
Contributor

@am29d am29d left a comment

Choose a reason for hiding this comment

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

Nice! Thanks for the update, now it's much better.

Copy link

sonarqubecloud bot commented Apr 9, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@am29d am29d merged commit 22d5134 into main Apr 9, 2024
@am29d am29d deleted the 2044-docs-update-release-process branch April 9, 2024 07: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 internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/M PR between 30-99 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: update release process
2 participants