Dependency Updates

This wiki page describes how to update the JWQL repository with dependency updates provided by pyup.

On the first day of each month, the pyup tool automatically opens up a new pull request in the jwql repository with suggested dependency updates. Since pyup only works on requirements.txt files and not conda environment files (see the currently open GitHub issue about this), someone must manually so into that branch/pull request and update the appropriate environment files. Below is a step-by-step procedure for doing this:

Find the pyup pull request and add appropriate assignees and labels.

The pull request will be named something like "Scheduled monthly dependency update for ". Open up the pull request on GitHub. Add yourself as an assignee. Add the label for "environment".

Check out the pyup branch to your local clone

The pyup tool opens the PR on a branch called pyup/scheduled-update-YYYY-MM-DD. Grab this branch in your local clone of the jwql repository with:

git fetch upstream # Assumes you have a remote called upstream pointing to https://github.com/spacetelescope/jwql.git git checkout -b pyup/scheduled-update-YYYY-MM-DD upstream/pyup/scheduled-update-YYYY-MM-DD

Check which dependency updates are actually updated in conda

Update environment/requirement files as necessary

Commit the changes to the environment/requirement files, push back to upstream

Ensure the GitHub Actions builds pass

Assign a reviewer and (eventually) merge