Changes

Jump to: navigation, search

ReleaseEngineering/How To/Update RelengAPI

779 bytes added, 13:34, 7 August 2015
Update to describe alembic
Will your change
;require a DB change:If so, you probably want to make that consider carefully whether the DB change beforehand, especially if it's as simple as `relengapi createdb`. If or the code change is incompatible, you'll probably need a change windowto be landed first.
;make an incompatible API change:If so, you should endeavor to make it non-incompatible, and otherwise announce the change to any users beforehand.
= Shipping It =
In whatever distribution you're working on, bump Figure out the next version number (in based on semantic versioning. Run `setupmisc/release.sh x.y.pyz`. This will open an editor to edit the release notes. Have a look at the merges included and summarize them. Try to include context ("retry database operations" doesn't say *which* database operations are retried), git tag it with the version, eand pull request numbers. See [https://api.pub.build.mozilla.org/docs/relnotes/2.g1., `0/ the 2.31.4`, and push0 notes] for a good example.
Build an sdist tarball:  python setup.py sdist Upload After tagging and pushing, upload the resulting tarball (in `dist/`) to relengapi:
scp dist/relengapi-mapper-2.3.4.tar.gz <your user>@relengwebadm.private.scl3.mozilla.com:/tmp
cd /data/releng/src/relengapi
and edit requirements.txt to specify the new version. Now, if you're ready to ship the change live with no DB updates or settings changes:  ./update This will upgrade the packages, build the docs, and deploy to the webheads. If you need to do some DB migrations or the like first:  ./update -n which will skip the deployment step. Thenupdate the DB schema (assuming the schema upgrade won't break the currently-deployed code from the previous release):  ./relengapi.sh alembic relengapi upgrade (or whatever changes you need to make before deploying the code). Finally, deploy the new code with
./update
will In some cases, you'll want to deploy the new code *before* the schema upgrade the packages, build the docsin which case, and deploy to the webheadsjust reverse those steps.
{{Release Engineering How To|Update RelengAPI}}
Canmove, confirm
1,394
edits

Navigation menu