update ci

Author: gilesknap

.github/workflows/_check.yml

@@ -0,0 +1,27 @@
+on:
+  workflow_call:
+    outputs:
+      branch-pr:
+        description: The PR number if the branch is in one
+        value: ${{ jobs.pr.outputs.branch-pr }}
+
+jobs:
+  pr:
+    runs-on: "ubuntu-latest"
+    outputs:
+      branch-pr: ${{ steps.script.outputs.result }}
+    steps:
+      - uses: actions/github-script@v7
+        id: script
+        if: github.event_name == 'push'
+        with:
+          script: |
+            const prs = await github.rest.pulls.list({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              head: context.repo.owner + ':${{ github.ref_name }}'
+            })
+            if (prs.data.length) {
+              console.log(`::notice ::Skipping CI on branch push as it is already run in PR #${prs.data[0]["number"]}`)
+              return prs.data[0]["number"]
+            }

.github/workflows/release.yaml .github/workflows/_release.yml.github/workflows/release.yaml renamed to .github/workflows/_release.yml

@@ -1,23 +1,21 @@
 name: "Release dev container features & Generate Documentation"
 on:
+  # use this to test releasing of the devcontainer features in a branch
   workflow_dispatch:
-  push:
-    branches:
-      - main
+  workflow_call:
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     permissions:
       contents: write
-      pull-requests: write
       packages: write
     steps:
       - uses: actions/checkout@v4
 
       - name: patch in version tag
-        # patch the version tag if the version is a valid semver. If not the
-        # default to the
+        # patch the version tag if the version is a valid semver. If not then
+        # default to 0.0.0-b1 (only when using workflow_dispatch for tests)
         run: |
           if [[ ${{ github.ref_name }} =~ ^[0-9]+\.[0-9]+.+ ]] ; then
             sed -i s/0\.0\.0-b1/${{ github.ref_name }}/ $(find .devcontainer -name devcontainer-feature.json)
@@ -35,6 +33,9 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      # the example features publishes docs like below - I believe this is only
+      # relevant if publishing to the marketplace?
+
       # - name: Create PR for Documentation
       #   id: push_image_info
       #   env:

.github/workflows/test.yaml .github/workflows/_test.yml.github/workflows/test.yaml renamed to .github/workflows/_test.yml

@@ -1,7 +1,6 @@
 name: "CI - Test Features"
 on:
-  push:
-  pull_request:
+  workflow_call:
 
 jobs:
   test-autogenerated:
@@ -20,7 +19,7 @@ jobs:
       - name: "Install latest devcontainer CLI"
         run: |
           npm install -g @devcontainers/cli
-          mkdir -p ~/.config/devcontainer_rc
+          mkdir -p ~/.config/bash-config
 
       - name: "Generating tests for '${{ matrix.features }}' against '${{ matrix.baseImage }}'"
         run: devcontainer features test --skip-scenarios -f ${{ matrix.features }} -i ${{ matrix.baseImage }} .

.github/workflows/validate.yml .github/workflows/_validate.yml.github/workflows/validate.yml renamed to .github/workflows/_validate.yml

@@ -1,6 +1,6 @@
 name: "Validate devcontainer-feature.json files"
 on:
-  pull_request:
+  workflow_call:
 
 jobs:
   validate:

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  check:
+    uses: ./.github/workflows/_check.yml
+
+  validate:
+    needs: check
+    if: needs.check.outputs.branch-pr == ''
+    uses: ./.github/workflows/_validate.yml
+
+  test:
+    needs: check
+    if: needs.check.outputs.branch-pr == ''
+    uses: ./.github/workflows/_test.yml
+
+  release:
+    if: github.ref_type == 'tag'
+    needs: test
+    uses: ./.github/workflows/_release.yml
+    permissions:
+      contents: write
+      packages: write
+