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.

Sign up for GitHub

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

Jump to bottom

readme: Add documentation on publishing a release #835

Merged
merged 1 commit into from
Jun 24, 2024
Merged

readme: Add documentation on publishing a release #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion docs/contributor/publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,42 @@ Versioning follows: aa.bb.cc and is based on tags in git
* cc == Patch version. Bug fix or small optional feature. Backward
compatibility maintained.

## Publishing Process
## Github Publishing Process

Note: If this release contains a breaking change, you may need to navigate to
the [Milestones](https://github.com/tianocore/edk2-pytool-extensions/milestones)
page and "edit" the milestone version to roll it to the next minor / major
version. If it was already done, then you don't need to do it again.

1. Navigate to the [Releases](https://github.com/tianocore/edk2-pytool-extensions/releases)
section on the main page of edk2-pytool-extensions
2. Click `Draft a new release` at the top right of the page
3. Click `Choose a tag` and create the new release version (`v0.21.8`, `v0.22.0`, etc.)
4. Click `Generate release notes`
5. Add a new section `## Dependency Updates`
6. If the major / minor is rolled in this release, add a `## Integration Steps`
section
7. Move all dependabot contributions to the `## Dependency Updates` section
8. Leave all "true" contributions in the `## What's Changed` section
9. Copy the integration steps from the pull request into the
`## Integration Steps` section
10. Click `Publish release`

These are the steps you need to do once a release is complete, to setup
contributing to the next tag.

1. Navigate to the [Milestones](https://github.com/tianocore/edk2-pytool-extensions/milestones)
section on the Pull requests page
2. Click `New Milestone` and create a new tag that should be the last release
with the patch version + 1
3. Click `Create milestone`
4. Close the old milestone for the latest release tag

NOTE: Feel free to add additional sections to the release notes as necessary.
The release is not immediate. A pipeline will be queued that will perform final
CI checks and then release to pypi. You can monitor this pipeline [HERE](https://dev.azure.com/tianocore/edk2-pytool-extensions/_build?definitionId=10)

## Manual Publishing Process

NOTE: These directions assume you have already configured your workspace for
developing. If not please first do that. Directions on the
Expand Down
2 changes: 2 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,8 @@ See the [github
team](https://github.com/orgs/tianocore/teams/edk-ii-tool-maintainers) for more
details.

Documentation for maintainers on how to publish a release can be found [here](https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/contributor/publishing.md)

## Documentation

[![docs]][_docs]
Expand Down