From ed6168fa71f00b0cf6b3515da12793e5bebf3bba Mon Sep 17 00:00:00 2001 From: "Matthew R. Becker" Date: Fri, 6 Sep 2024 09:39:34 -0500 Subject: [PATCH 1/2] doc: add docs on the lockfile and envs --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 751715bef..6c22021dd 100644 --- a/README.md +++ b/README.md @@ -235,6 +235,24 @@ If your migrator needs special configuration, you should write a new factory fun - `CF_FEEDSTOCK_OPS_CONTAINER_NAME`: the name of the container to use in the bot, otherwise defaults to `ghcr.io/regro/conda-forge-tick` - `CF_FEEDSTOCK_OPS_CONTAINER_TAG`: set this to override the default container tag used in production runs, otherwise the value of `__version__` is used +### Getting a Working Environment + +The bot has an abstract set of requirements stored in the `environment.yml` file in this repo. + +It's production environment is locked via `conda-lock`. The lockfile is stored in `cf-graph-countyfair` +at [https://github.com/regro/cf-graph-countyfair/blob/master/conda-lock.yml](https://github.com/regro/cf-graph-countyfair/blob/master/conda-lock.yml). +The production environment is relocked regularly using a GitHub Actions [job](https://github.com/regro/cf-graph-countyfair/actions/workflows/relock.yaml). + +There are two ways to get a working environment: + +1. Use the `environment.yml` file in the repo with `conda env`. +2. Download the lockfile and use `conda-lock`. The best way to download the lockfile is via `wget` or `curl` or similar: + + ```bash + wget https://raw.githubusercontent.com/regro/cf-graph-countyfair/master/conda-lock.yml + ``` + since clones of `cf-graph-countyfair` are slow. + ### Running Tests The test suite relies on `pytest` and uses `docker`. To run the tests, use the following command: From b2ab4bed4ac7f4551d70bb6d0acc7e398b8be896 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 6 Sep 2024 14:43:06 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6c22021dd..5fd3e20df 100644 --- a/README.md +++ b/README.md @@ -237,17 +237,17 @@ If your migrator needs special configuration, you should write a new factory fun ### Getting a Working Environment -The bot has an abstract set of requirements stored in the `environment.yml` file in this repo. +The bot has an abstract set of requirements stored in the `environment.yml` file in this repo. -It's production environment is locked via `conda-lock`. The lockfile is stored in `cf-graph-countyfair` -at [https://github.com/regro/cf-graph-countyfair/blob/master/conda-lock.yml](https://github.com/regro/cf-graph-countyfair/blob/master/conda-lock.yml). +It's production environment is locked via `conda-lock`. The lockfile is stored in `cf-graph-countyfair` +at [https://github.com/regro/cf-graph-countyfair/blob/master/conda-lock.yml](https://github.com/regro/cf-graph-countyfair/blob/master/conda-lock.yml). The production environment is relocked regularly using a GitHub Actions [job](https://github.com/regro/cf-graph-countyfair/actions/workflows/relock.yaml). There are two ways to get a working environment: 1. Use the `environment.yml` file in the repo with `conda env`. 2. Download the lockfile and use `conda-lock`. The best way to download the lockfile is via `wget` or `curl` or similar: - + ```bash wget https://raw.githubusercontent.com/regro/cf-graph-countyfair/master/conda-lock.yml ```