Add environment.lock and workflow to update it weekly (#641)

Author: claytonparnell

.github/workflows/build-image.yml

@@ -42,7 +42,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: mamba-org/setup-micromamba@v1
         with:
-          environment-file: ./environment.yml
+          environment-file: ./environment.lock
           environment-name: sagemaker-distribution
           init-shell: bash
       - name: Free up disk space

.github/workflows/check-image-size.yml

@@ -41,7 +41,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: mamba-org/setup-micromamba@v1
         with:
-          environment-file: ./environment.yml
+          environment-file: ./environment.lock
           environment-name: sagemaker-distribution
           init-shell: bash
       - name: Free up disk space

.github/workflows/check_code_quality.yml

@@ -31,7 +31,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: mamba-org/setup-micromamba@v1
         with:
-          environment-file: ./environment.yml
+          environment-file: ./environment.lock
           environment-name: sagemaker-distribution
           init-shell: bash
       - name: Free up disk space

.github/workflows/update-environment-lock.yml

@@ -0,0 +1,36 @@
+name: Update environment.lock
+# Update environment.lock weekly, so we can quickly install environment without having
+# to solve environment.yml every time.
+on:
+  # Every Monday
+  schedule:
+    - cron: '0 0 * * MON'
+  # Manually call
+  workflow_dispatch:
+defaults:
+  run:
+    shell: bash -l {0}
+jobs:
+  update-environment:
+    name: Install environment.yml, generate environment.lock
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-file: ./environment.yml
+          environment-name: sagemaker-distribution
+          init-shell: bash
+      - name: Create environment-lock.yml
+        run: micromamba env export --explicit > environment.lock
+      - name: Run sagemaker-distribution unit tests to check for regressions
+        run: pytest -m unit
+      - name: Commit changes
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add environment.lock
+          git commit -m 'Update environment.lock'
+          git push

CONTRIBUTING.md

@@ -61,7 +61,7 @@ Follow these steps for sending out a pull request for adding new packages:
    ```
    This project uses Conda to manage its dependencies. Run the following to setup your local environment:
 
-   conda env update --file environment.yml -n sagemaker-distribution
+   conda env update --file environment.lock -n sagemaker-distribution
 
    conda activate sagemaker-distribution
 

DEVELOPMENT.md

@@ -3,7 +3,7 @@
 This project uses Conda to manage its dependencies. Run the following to setup your local environment:
 
 ```shell
-conda env update --file environment.yml -n sagemaker-distribution
+conda env update --file environment.lock -n sagemaker-distribution
 ```
 
 ## Tests