Merge pull request #1 from gilesknap/ci

Get CI working and publishing feature version based on git tag

Author: gilesknap

.devcontainer/features/bash-config/README.md

@@ -2,25 +2,14 @@
 
 ## Defaults
 
-When this feature is first called, onCreateCommand.sh is created and called in `devcontainer-feature`. 
-This creates and installs a default bash terminal configuration from `feature_settings_rc` which contains opinionated default BASH terminal settings such as:
-* A minimalist, blue bash prompt.
-* Eternal, shared history between containers using this feature.
-
-## Customisation
-
-The user can specify their own terminal preferences in `$CONFIG_STAGING/bashrc`, which defaults to `/devcontainer_staging/bashrc`.
-Then the container is rebuilt, if `bashrc` already exists it won't be overwritten, preserving changes. If the container has been built once already, the existing bashrc must be deleted in order for your changes to be applied. 
+The default, opinionated configuration is defined in
+`$HOME/.config/bash-config/bash-config-rc` and includes the following:
 
+- Persistent history across all devcontainers that use this feature
+- The MS devcontainer bash prompt with git branch and status
+- history search with up/down arrows (.inputrc)
+- ctrl-left or right arrow for word navigation (.inputrc)
 
+## Customisation
 
-creates staging folder in container 
-creates onCreateCommand.sh in the staging folder
-inputrc and bashrc are also created in the staging folder, containing incremental history searching and user customisations respectively
-feature_settings_rc is created in the staging fodler, which contains a PS1 setup and opinionated terminal features 
-"onCreateCommand" is then exectuted inside the container during finalisation of container setup.
- - This copies the contents of feature_settings_rc into devcontainer_rc
- - then copies bashrc and inputrc into the container, unless they exist already to prevent overwriting user edits
- - then adds root permissions.
-A symbolic link to /root/ is created The items in the CONFIG_FOLDER
-our bashrc is called by /root/.bashrc
+Can be customized by editing `$HOME/.config/bash-config/bashrc`

.devcontainer/features/bash-config/devcontainer-feature.json

@@ -2,7 +2,8 @@
     "name": "Lightweight and configurable BASH eternal history",
     //ID *must* match parent folder name *exactly*
     "id": "bash-config",
-    "version": "1.0.0",
+    // a default beta version that is replaced by CI when doing tagged releases
+    "version": "0.0.1-b1",
     "description": "Lightweight BASH setup with eternal history and PS1 tweaks. Fully configurable.",
     "documentationURL": "https://raw.githubusercontent.com/DiamondRC/devcontainer-features/refs/heads/main/.devcontainer/features/bash-config/README.md",
     "containerEnv": {
@@ -17,4 +18,4 @@
         }
     ],
     "onCreateCommand": "bash /devcontainer_staging/onCreateCommand.sh"
-}
+}

.github/workflows/release.yaml

@@ -1,10 +1,12 @@
 name: "Release dev container features & Generate Documentation"
 on:
   workflow_dispatch:
+  push:
+    branches:
+      - main
 
 jobs:
   deploy:
-    if: ${{ github.ref == 'refs/heads/main' }}
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -13,13 +15,23 @@ jobs:
     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
+        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)
+            # dump the modified json for debugging
+            cat $(find .devcontainer -name devcontainer-feature.json)
+          fi
+
       - name: "Publish Features"
         uses: devcontainers/action@v1
         with:
           publish-features: "true"
           base-path-to-features: "./src"
           generate-docs: "true"
-          
+
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

.github/workflows/test.yaml

@@ -1,10 +1,7 @@
 name: "CI - Test Features"
 on:
   push:
-    branches:
-      - main
   pull_request:
-  workflow_dispatch:
 
 jobs:
   test-autogenerated:
@@ -13,7 +10,7 @@ jobs:
     strategy:
       matrix:
         features:
-          - terminal-history
+          - bash-config
         baseImage:
           - debian:latest
           - ubuntu:latest
@@ -24,35 +21,7 @@ jobs:
         run: |
           npm install -g @devcontainers/cli
           mkdir -p ~/.config/devcontainer_rc
-          
+
       - name: "Generating tests for '${{ matrix.features }}' against '${{ matrix.baseImage }}'"
         run: devcontainer features test --skip-scenarios -f ${{ matrix.features }} -i ${{ matrix.baseImage }} .
 
-#  test-scenarios:
-#    runs-on: ubuntu-latest
-#    continue-on-error: true
-#    strategy:
-#      matrix:
-#        features:
-#          - color
-#          - hello
-#    steps:
-#      - uses: actions/checkout@v4
-#
-#      - name: "Install latest devcontainer CLI"
-#        run: npm install -g @devcontainers/cli
-#
-#      - name: "Generating tests for '${{ matrix.features }}' scenarios"
-#        run: devcontainer features test -f ${{ matrix.features }} --skip-autogenerated --skip-duplicated .
-#
-#  test-global:
-#    runs-on: ubuntu-latest
-#    continue-on-error: true
-#    steps:
-#      - uses: actions/checkout@v4
-#
-#      - name: "Install latest devcontainer CLI"
-#        run: npm install -g @devcontainers/cli
-#
-#      - name: "Testing global scenarios"
-#        run: devcontainer features test --global-scenarios-only .

test/bash-config/scenarios.json

@@ -0,0 +1,8 @@
+{
+    "hello": {
+        "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+        "features": {
+            "bash-config": {}
+        }
+    }
+}

test/bash-config/test.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+# Import test library bundled with the devcontainer CLI
+# See https://github.com/devcontainers/cli/blob/HEAD/docs/features/test.md#dev-container-features-test-lib
+# Provides the 'check' and 'reportResults' commands.
+source dev-container-features-test-lib
+
+# Feature-specific tests
+# The 'check' command comes from the dev-container-features-test-lib. Syntax is...
+# check <LABEL> <cmd> [args...]
+check "execute command" bash -c "test $HISTFILE == $CONFIG_FOLDER/.bash_eternal_history"
+
+# Report results
+# If any of the checks above exited with a non-zero exit code, the test will fail.
+reportResults