|
| 1 | +Contributing and Maintenance Guide |
| 2 | +================================== |
| 3 | + |
| 4 | +Bedevere web service is deployed to Heroku, which is managed by The PSF. |
| 5 | + |
| 6 | +Deployment |
| 7 | +---------- |
| 8 | + |
| 9 | +There are two ways to have bedevere deployed: automatic deployment, and |
| 10 | +manual deployment. |
| 11 | + |
| 12 | +Automatic Deployment (currently broken) |
| 13 | +''''''''''''''''''''''''''''''''''''''' |
| 14 | + |
| 15 | +When the automatic deployment is enabled (on Heroku side), any merged PR |
| 16 | +will automatically be deployed to Heroku. This process takes less than 5 minutes. |
| 17 | + |
| 18 | +If after 10 minutes you did not see the changes reflected, please ping one |
| 19 | +of the collaborators listed below. |
| 20 | + |
| 21 | + |
| 22 | +.. note:: |
| 23 | + |
| 24 | + Due to recent `security incident`_, the Heroku GitHub integration is broken. |
| 25 | + Automatic deployment does not currently work. Until this gets resolved, |
| 26 | + maintainers have to deploy bedevere to Heroku manually. |
| 27 | + |
| 28 | + |
| 29 | +Manual Deployment |
| 30 | +''''''''''''''''' |
| 31 | + |
| 32 | +The app can be deployed manually to Heroku by collaborators and members of the ``bedevere`` app on Heroku. |
| 33 | +Heroku admins can do it too. |
| 34 | + |
| 35 | +#. Install Heroku CLI |
| 36 | + |
| 37 | + Details at: https://devcenter.heroku.com/articles/heroku-cli |
| 38 | + |
| 39 | +#. Login to Heroku CLI on the command line and follow instructions |
| 40 | + |
| 41 | + :: |
| 42 | + |
| 43 | + heroku login |
| 44 | + |
| 45 | + |
| 46 | +#. If you haven't already, get a clone of the bedevere repo |
| 47 | + |
| 48 | + :: |
| 49 | + |
| 50 | + git clone git@github.com:python/bedevere.git |
| 51 | + |
| 52 | + Or, using `GitHub CLI`_ |
| 53 | + |
| 54 | + :: |
| 55 | + |
| 56 | + gh repo clone python/bedevere |
| 57 | + |
| 58 | +#. From the ``bedevere`` directory, add the ``bedevere`` Heroku app as remote branch |
| 59 | + |
| 60 | + :: |
| 61 | + |
| 62 | + heroku git:remote -a bedevere |
| 63 | + |
| 64 | + |
| 65 | +#. From the ``bedevere`` directory, push to Heroku |
| 66 | + |
| 67 | + :: |
| 68 | + |
| 69 | + git push heroku main |
| 70 | + |
| 71 | + |
| 72 | +After a successful push, the deployment will begin. |
| 73 | + |
| 74 | +Heroku app collaborators and members |
| 75 | +'''''''''''''''''''''''''''''''''''' |
| 76 | + |
| 77 | +- @Mariatta |
| 78 | +- @ambv |
| 79 | +- @brettcannon |
| 80 | + |
| 81 | +.. _security incident: https://status.heroku.com/incidents/2413 |
| 82 | +.. _GitHub CLI: https://cli.github.com/ |
0 commit comments