Merge pull request #8 from switchbox-data/gha-devcontainer

Use devcontainer in GHA if python_data_science is selected

Author: MeadBarrel

template/{% if python %}.pre-commit-config.yaml{% endif %}.jinja

@@ -17,6 +17,7 @@ repos:
       - id: check-json
       - id: check-toml
       - id: check-added-large-files
+        exclude: uv.lock
       - id: check-merge-conflict
       - id: check-case-conflict
 
@@ -25,4 +26,4 @@ repos:
       - id: ty
         name: ty check
         entry: uv run ty check . --ignore unresolved-import
-        language: system
+        language: system

template/{% if use_github %}.github{% endif %}/actions/{% if use_github and python_data_science %}run-in-devcontainer{% endif %}/action.yml

@@ -0,0 +1,12 @@
+name: Run in devcontainer
+description: "Run a command in a devcontainer shell"
+inputs:
+  runCmd:
+    description: command to run
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - shell: /usr/bin/bash -e -c "devcontainer exec --workspace-folder . bash -e - < '{0}'"
+      run: ${{ inputs.runCmd }}

template/{% if use_github %}.github{% endif %}/workflows/{% if python_data_science and not python_package %}data-science-main.yml{% endif %}.jinja

@@ -0,0 +1,33 @@
+name: Main
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    types: [ opened, synchronize, reopened, ready_for_review ]
+
+jobs:
+  tests-and-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: devcontainers/[email protected]
+        with:
+          push: never
+          runCmd: echo "Container started"
+
+      - name: run pre-commit hooks
+        uses: ./.github/actions/run-in-devcontainer
+        with:
+          runCmd: prek -a
+
+      - name: run tests
+        uses: ./.github/actions/run-in-devcontainer
+        with:
+          runCmd: uv run python -m pytest tests
+
+      - name: ty check
+        uses: ./.github/actions/run-in-devcontainer
+        with:
+          runCmd: uv run ty check

…n %}on-release-main.yml{% endif %}.jinja …e %}on-release-main.yml{% endif %}.jinjatemplate/{% if use_github %}.github{% endif %}/workflows/{% if use_github and python %}on-release-main.yml{% endif %}.jinja renamed to template/{% if use_github %}.github{% endif %}/workflows/{% if python_package %}on-release-main.yml{% endif %}.jinja template/{% if use_github %}.github{% endif %}/workflows/{% if use_github and python %}on-release-main.yml{% endif %}.jinja renamed to template/{% if use_github %}.github{% endif %}/workflows/{% if python_package %}on-release-main.yml{% endif %}.jinja

@@ -5,15 +5,14 @@ on:
     types: [published]
 
 jobs:
-{% if python_package %}
   set-version:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
 
       - name: Export tag
         id: vars
-        run: echo tag=${{'{{'}}GITHUB_REF#refs/*/{{'}}'}} >> $GITHUB_OUTPUT
+        run: echo tag=${GITHUB_REF#refs/tags/} >> $GITHUB_OUTPUT
         if: ${{'{{'}} github.event_name == 'release' {{'}}'}}
 
       - name: Update project version
@@ -64,4 +63,3 @@ jobs:
 
       - name: Deploy documentation
         run: uv run mkdocs gh-deploy --force
-{% endif %}

…b and python %}main.yml{% endif %}.jinja …python-package-main.yml{% endif %}.jinjatemplate/{% if use_github %}.github{% endif %}/workflows/{% if use_github and python %}main.yml{% endif %}.jinja renamed to template/{% if use_github %}.github{% endif %}/workflows/{% if python_package %}python-package-main.yml{% endif %}.jinja template/{% if use_github %}.github{% endif %}/workflows/{% if use_github and python %}main.yml{% endif %}.jinja renamed to template/{% if use_github %}.github{% endif %}/workflows/{% if python_package %}python-package-main.yml{% endif %}.jinja

@@ -20,7 +20,6 @@ jobs:
       - name: Run ruff, ty and pre-commit hooks
         uses: j178/prek-action@v1
 
-
   tests-and-type-check:
     runs-on: ubuntu-latest
     strategy:
@@ -45,7 +44,6 @@ jobs:
       - name: Check typing
         run: uv run ty check
 
-{% if python_package %}
   check-docs:
     runs-on: ubuntu-latest
     steps:
@@ -57,7 +55,7 @@ jobs:
 
       - name: Check if documentation can be built
         run: uv run mkdocs build -s
-        
+
   deploy-docs:
     if: github.event_name == 'push'
     needs: [check-docs]
@@ -71,5 +69,4 @@ jobs:
         uses: ./.github/actions/setup-python-env
 
       - name: Deploy documentation
-        run: uv run mkdocs gh-deploy --force        
-{% endif %}
+        run: uv run mkdocs gh-deploy --force

tests/test_template.py

@@ -157,7 +157,7 @@ def test_python_mkdocs_only(tmp_path: Path) -> None:
     assert_file_contains(dest, "Justfile", "# 📚 DOCUMENTATION")
     assert_file_contains(dest, "Justfile", "docs:")
     # Check that GitHub workflow contains docs check job (python_package boolean bug)
-    assert_file_contains(dest, ".github/workflows/main.yml", "check-docs:")
+    assert_file_contains(dest, ".github/workflows/python-package-main.yml", "check-docs:")
     # Check that release workflow contains set-version job (python_package boolean bug)
     assert_file_contains(dest, ".github/workflows/on-release-main.yml", "set-version:")