From 64f8dd891fc723f42adbd4cf7704541b18a8f4df Mon Sep 17 00:00:00 2001 From: redshiftzero Date: Tue, 18 Jun 2019 12:00:39 -0700 Subject: [PATCH] README: RM/maintainer doc changes needed for nightly builds --- README.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2d760039..d5f7a4e6 100644 --- a/README.md +++ b/README.md @@ -23,24 +23,31 @@ make install-deps make fetch-wheels ``` -## Make a release +## Updating Python wheels + +Maintainers of `securedrop-client` and `securedrop-proxy` must ensure that +the requirements files which are used for build of these packages (`build-requirements.txt`) +using `make requirements` are kept up to date in latest `master` of those repositories. + +If new dependencies were added in the `requirements.txt` of that +repo that are not in the FPF PyPI mirror, then the maintainer needs +to: -Release managers of `securedrop-client` and `securedrop-proxy` must update -the requirements files which are used for build of these packages using -`make requirements`. If new dependencies were added in the `requirements.txt` of that -repo that are not in the FPF PyPI mirror, then the release manager needs -to build those wheels and push the tarball and wheel package of the new -dependency to the FPF PyPI mirror using `make build-wheels`. +1. Build those wheels using `make build-wheels` +2. Push the tarball and wheel package of the new +dependency to the FPF PyPI mirror using the steps described [here](https://github.com/freedomofpress/securedrop-debian-packaging-guide/issues/6). +3. Make a PR updating the shasums and signature in this repository. +4. Once this is done, `make requirements` can be used to update `build-requirements.txt` +in the repository to be packaged. + +## Make a release Summarizing release manager steps: 1. Update versions as necessary -2. `make requirements` -3. Do a test build following steps below -4. Make any changes as necessary and create a PR with the modifications from steps 1-4 -5. Push the release tag for use in building - -This means that the `build-requirements.txt` files will be updated by release managers, not developers. Developers should update `requirements.txt`. +2. Do a test build following steps below +3. Make any changes as necessary and create a PR into the repository to be packaged with the modifications from steps 1-3 +4. Push the release tag for use in building ## Build a package