8000 Add contributing and maintenance guide by Mariatta · Pull Request #454 · python/bedevere · GitHub
[go: up one dir, main page]

Skip to content

Add contributing and maintenance guide #454

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.

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

Merged
merged 4 commits into from
May 13, 2022
Merged
Changes from 1 commit
Commits
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
70 changes: 70 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
Contributing and Maintenance Guide
==================================

Deploying bedevere
------------------

Bedevere web service is deployed to Heroku, which is managed by The PSF.

Changes are supposed to be deployed to Heroku immediately after the PR gets merged,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is/was this supposed to happen? What is triggering the deployment?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merging the PR against main will trigger the auto-deployment.

I've addressed in #455. Please check.

however, due to recent `security incident`_,
the Heroku GitHub integration is broken.

Until this gets resolved, maintainers have to deploy bedevere to Heroku manually.

Who can deploy to Heroku
~~~~~~~~~~~~~~~~~~~~~~~~

People listed as Collaborator/Member on the ``bedevere`` Heroku app can deploy to Heroku.
Additionally, Heroku admins can also do it.

Collaborators/members:

- @Mariatta
- @ambv
- @brettcannon

How to deploy manually to Heroku
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#. Install Heroku CLI

Details at: https://devcenter.heroku.com/articles/heroku-cli

#. Login to Heroku CLI on the command line and follow instructions

::

heroku login


#. If you haven't already, get a clone of the bedevere repo

::

git clone git@github.com:python/bedevere.git

Or, using `GitHub CLI`_

::

gh repo clone python/bedevere

#. From the ``bedevere`` directory, add the ``bedevere`` Heroku app as remote branch

::

heroku git:remote -a bedevere


#. From the ``bedevere`` directory, push to Heroku

::

git push heroku main


Afther a successful push, the deployment will begin.

.. _security incident: https://status.heroku.com/incidents/2413
.. _GitHub CLI: https://cli.github.com/
0