Skip to content

Commit

Permalink
📝 Add a docs section about runtime requiements
Browse files Browse the repository at this point in the history
  • Loading branch information
webknjaz committed Apr 8, 2019
1 parent 5933742 commit f3d4b32
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,26 @@ The documentation isn't ready yet so I suggest you going through the
understanding of GitHub Apps and how to write them with octomachinery.

.. _`How-to create a GitHub Bot tutorial`: https://tutorial.octomachinery.dev

Runtime pre-requisites
----------------------

* Python 3.7+ as octomachinery relies on :py:mod:`contextvars` which
doesn't have a backport.
* GitHub App credentials and GitHub Action events are supplied via
environment variables. They are also loaded from a ``.env`` file if it
exists in a development environment.

.. warning::

Be aware that some tools in your environment may conflict with
autoloading vars from a ``.env`` file. It is recommended to disable
those. One example of such tool is `Pipenv`_.

.. _`Pipenv`:
https://pipenv.readthedocs.io/en/latest/advanced/
#automatic-loading-of-env

For the production deployments, please use a way of supplying env vars
via tools provided by the application orchestration software of your
choice.

0 comments on commit f3d4b32

Please sign in to comment.