phylum-ci 0.0.2rc5

Utilities for Phylum integrations

phylum-ci

Python package for handling CI and other integrations

Local Development

Here's how to set up phylum-ci for local development.

1. Clone the phylum-ci repo locally

   git clone [e-mail]:phylum-dev/phylum-ci.git
   

2. Ensure all supported Python versions are installed locally

   1. The strategy is to support all released minor versions of Python that are not end-of-life yet
   2. The current list is 3.7, 3.8, 3.9, and 3.10, but the Python Developer's Guide can be referenced for the status of active Python releases
   3. It is recommended to use pyenv to manage multiple Python installations

   # Use `pyenv install --list` to get available versions and usually install the latest patch version.
   # NOTE: These versions are examples; the latest patch version available from pyenv should be used in place of `.x`.
   #       example: `pyenv install --list |grep 3.9.` to show latest patch version for the cpython 3.9 minor release.
   pyenv install 3.7.x
   pyenv install 3.8.x
   pyenv install 3.9.x
   pyenv install 3.10.x
   pyenv rehash
   # Ensure all environments are available globally (helps tox to find them)
   pyenv global 3.10.x 3.9.x 3.8.x 3.7.x
   

3. Ensure poetry is installed

4. Install dependencies with poetry, which will automatically create a virtual environment:

   cd phylum-ci
   poetry install
   

5. Create a branch for local development:

   git checkout -b <name-of-your-branch>
   

   Now you can make your changes locally.

6. If new dependencies are added, ensure the poetry.lock file is updated (and committed):

   poetry lock
   

7. When you're done making changes, check that your changes pass the tests:

   poetry run tox
   

8. Commit your changes and push your branch to GitHub:

   git add .
   git commit -m "Description of the changes goes here"
   git push --set-upstream origin <name-of-your-branch>
   

9. Submit a pull request through the GitHub website