docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge 125d6aa4bc into 6e6a273573

This commit is contained in:
Christopher Petito 2025-07-30 10:13:43 -07:00 committed by GitHub
parent 6e6a273573 125d6aa4bc
commit 39d52a1b0b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -120,14 +120,21 @@ $ make docs
$ open _build/index.html $ open _build/index.html
``` ```
## Release Checklist ## Deployment
Before a new release, please go through the following checklist: To deploy a new release, please go through the following steps:
* Bump version in docker/version.py * Make sure a release note for the changes included since the last published version is present in [docs/change-log.md](./docs/change-log.md);
* Add a release note in docs/change_log.md * Go to the [`Release`](https://github.com/docker/docker-py/actions/workflows/release.yml) GitHub action page and click on `Run workflow`. Here:
* Git tag the version * Insert the version number you want to give to the new package, **without** the `v.` prefix (eg. `7.1.0`). This version should correspond with the one written in [docs/change-log.md](./docs/change-log.md);
* Upload to pypi * Make sure `Dry run` is checked;
* Click `Run workflow`;
* Click on the newly executed workflow, click on the `publish` job, and under `Generate Package` check to see if the package has been built successfully and with the correct version number.
* Once the `Dry run` of the workflow has run successfully, repeat the workflow steps again, this time making sure `Dry run` is deselected;
* Once the workflow has successfully completed, there should now be a draft release present in [the releases page](https://github.com/docker/docker-py/releases);
* Edit this draft release to include the same details as added in [docs/change-log.md](./docs/change-log.md);
* Make sure the `Mark as latest` checkbox is selected;
* Publish the draft release.
## Vulnerability Reporting ## Vulnerability Reporting
For any security issues, please do NOT file an issue or pull request on github! For any security issues, please do NOT file an issue or pull request on github!