MLOS DevContainer #256
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: MLOS DevContainer | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| tags: | |
| description: Manual MLOS DevContainer run | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| merge_group: | |
| types: [checks_requested] | |
| schedule: | |
| - cron: "1 0 * * *" | |
| jobs: | |
| DevContainer: | |
| runs-on: ubuntu-latest | |
| # Here we only test a single (latest) version of python. | |
| env: | |
| DOCKER_BUILDKIT: 1 | |
| BUILDKIT_INLINE_CACHE: 1 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set NO_CACHE variable for nightly builds | |
| if: github.event_name == 'schedule' | |
| run: | | |
| echo "NO_CACHE=true" >> $GITHUB_ENV | |
| - name: Log some environment variables for debugging | |
| run: | | |
| set -x | |
| printenv | |
| echo "NO_CACHE: ${NO_CACHE:-}" | |
| - name: Build the devcontainer image | |
| timeout-minutes: 15 | |
| run: | | |
| set -x | |
| make CONDA_INFO_LEVEL=-v devcontainer | |
| - name: Start the devcontainer in the background | |
| timeout-minutes: 3 | |
| run: | | |
| set -x | |
| docker run -d --rm --user root \ | |
| --volume /var/run/docker.sock:/var/run/docker.sock \ | |
| --env DOCKER_BUILDKIT=$DOCKER_BUILDKIT \ | |
| --volume $(pwd):/workspaces/MLOS \ | |
| --env CONTAINER_WORKSPACE_FOLDER=/workspaces/MLOS \ | |
| --env LOCAL_WORKSPACE_FOLDER=$(pwd) \ | |
| --workdir /workspaces/MLOS \ | |
| --name mlos-devcontainer mlos-devcontainer sleep infinity | |
| - name: Fixup vscode uid/gid in the running container | |
| timeout-minutes: 3 | |
| run: | | |
| set -x | |
| docker exec --user root mlos-devcontainer groupmod -g `id -g` vscode | |
| docker exec --user root mlos-devcontainer usermod -u `id -u` -g `id -g` vscode | |
| docker exec --user root mlos-devcontainer chown -R vscode:vscode /home/vscode | |
| docker exec --user root mlos-devcontainer mkdir -p /opt/conda/pkgs/cache /var/cache/pip | |
| docker exec --user root mlos-devcontainer chown -R vscode /opt/conda/pkgs/cache /var/cache/pip | |
| - name: Update the conda env in the devcontainer | |
| timeout-minutes: 10 | |
| run: | | |
| set -x | |
| docker exec --user vscode mlos-devcontainer make CONDA_INFO_LEVEL=-v conda-env | |
| - name: Check for missing licenseheaders | |
| timeout-minutes: 3 | |
| run: | | |
| set -x | |
| docker exec --user vscode mlos-devcontainer make CONDA_INFO_LEVEL=-v licenseheaders | |
| # licenseheaders changes the contents of the files, so make this check fail if there are any changes detected | |
| git --no-pager diff --exit-code | |
| - name: Run lint checks | |
| timeout-minutes: 5 | |
| run: | | |
| set -x | |
| docker exec --user vscode --env MAKEFLAGS=-Oline mlos-devcontainer make CONDA_INFO_LEVEL=-v check | |
| - name: Run tests | |
| timeout-minutes: 10 | |
| run: | | |
| set -x | |
| # Simulate test collection in vscode. | |
| docker exec --user vscode mlos-devcontainer \ | |
| conda run -n mlos python -m pytest -svxl -n auto --collect-only --rootdir /workspaces/MLOS -s --cache-clear | |
| # Now actually run the tests. | |
| docker exec --user vscode mlos-devcontainer make CONDA_INFO_LEVEL=-v test | |
| - name: Generate and test binary distribution files | |
| timeout-minutes: 10 | |
| run: | | |
| set -x | |
| docker exec --user vscode mlos-devcontainer make CONDA_INFO_LEVEL=-v dist dist-test | |
| - name: Test rebuilding the devcontainer in the devcontainer | |
| timeout-minutes: 3 | |
| run: | | |
| set -x | |
| docker exec --user vscode mlos-devcontainer make CONDA_INFO_LEVEL=-v devcontainer | |
| - name: Generate docs and test check them | |
| run: | | |
| set -x | |
| docker exec --user vscode --env MAKEFLAGS=-Oline mlos-devcontainer make CONDA_INFO_LEVEL=-v doc | |
| # Make sure we can publish the coverage report. | |
| rm -f doc/build/html/htmlcov/.gitignore | |
| - name: Deploy to GitHub pages | |
| if: github.ref == 'refs/heads/main' | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: doc/build/html | |
| clean: true | |
| - name: Cleanup the devcontainer | |
| run: | | |
| set -x | |
| docker stop -t 1 mlos-devcontainer || true | |
| docker rm --force mlos-devcontainer || true | |
| - name: Container Registry Login | |
| if: github.repository == 'microsoft/mlos' && github.ref == 'refs/heads/main' | |
| uses: docker/login-action@v2 | |
| with: | |
| registry: ${{ secrets.ACR_LOGINURL }} | |
| username: ${{ secrets.ACR_USERNAME }} | |
| password: ${{ secrets.ACR_PASSWORD }} | |
| - name: Publish the container images | |
| if: github.repository == 'microsoft/mlos' && github.ref == 'refs/heads/main' | |
| timeout-minutes: 15 | |
| # We only push to the :latest tag, to avoid needing to cleanup the | |
| # registry manually (there's currently no API for that). | |
| run: | | |
| set -x | |
| docker tag devcontainer-cli:latest ${{ secrets.ACR_LOGINURL }}/devcontainer-cli:latest | |
| docker push ${{ secrets.ACR_LOGINURL }}/devcontainer-cli:latest | |
| docker tag mlos-devcontainer:latest ${{ secrets.ACR_LOGINURL }}/mlos-devcontainer:latest | |
| docker push ${{ secrets.ACR_LOGINURL }}/mlos-devcontainer:latest |