Add Devcontainer Feature and Automated Publishing Workflow

.devcontainer/devcontainer-with-cvmfs.json

@@ -0,0 +1,8 @@
+{
+    "name": "CVMFS Action Test",
+    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+    "features": {
+        "ghcr.io/cvmfs-contrib/github-action-cvmfs/cvmfs": {}
+    },
+    "forwardPorts": []
+}

.github/workflows/package-feature.yml

@@ -0,0 +1,14 @@
+name: Package Devcontainer Feature
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - name: Install Devcontainer CLI
+        run: npm install -g @devcontainers/cli
+      - name: Package CVMFS Feature
+        run: devcontainer features package src/cvmfs/
+      - name: Generate CVMFS Feature Docs
+        run: devcontainer features generate-docs -p src/ -n cvmfs-contrib/cvmfs

.github/workflows/publish-feature.yml

@@ -0,0 +1,40 @@
+name: Publish Devcontainer Feature
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        description: 'The version to publish'
+        required: true
+        type: string
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Devcontainer CLI
+        run: npm install -g @devcontainers/cli
+
+      - name: Login to GitHub Container Registry
+        run: echo "${{ secrets.WRITE_PACKAGES_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+
+      - name: Add version to environment
+        run: |
+          VERSION="${{ inputs.version || github.ref_name }}"
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Add version to devcontainer-feature.json
+        run: |
+          jq --arg VERSION "${{ env.VERSION }}" '.version = $VERSION' src/cvmfs/devcontainer-feature.json > tmp.json
+          mv tmp.json src/cvmfs/devcontainer-feature.json
+
+      - name: Publish Devcontainer Feature
+        run: devcontainer features publish --namespace ${{ github.actor }}/${{ github.repository }} .
+
+      - name: Build Devcontainer Feature
+        run: devcontainer build --workspace-folder . --image-name test-cvmfs-feature --additional-features ghcr.io/${{ github.actor }}/${{ github.repository }}/cvmfs:${{ env.VERSION }}

README.devcontainer.md

@@ -0,0 +1,39 @@
+# CVMFS Devcontainer Feature
+
+This directory contains a devcontainer feature for installing and configuring the CVMFS client.
+
+## Publishing to GHCR
+
+This feature is intended to be published to the GitHub Container Registry (GHCR) to be easily reusable by other projects.
+
+### Manual Publishing
+
+1.  **Install the Devcontainer CLI:**
+    ```bash
+    npm install -g @devcontainers/cli
+    ```
+
+2.  **Create a Personal Access Token (PAT):**
+    *   Go to GitHub **Settings** > **Developer settings** > **Personal access tokens** > **Tokens (classic)**.
+    *   Generate a new token with the `write:packages` scope.
+    *   Export the token as an environment variable:
+        ```bash
+        export WRITE_PACKAGES_TOKEN=your-personal-access-token
+        ```
+
+3.  **Log in to GHCR:**
+    ```bash
+    echo $WRITE_PACKAGES_TOKEN | docker login ghcr.io -u your-github-username --password-stdin
+    ```
+
+4.  **Publish the Feature:**
+    Run the following command from the root of this repository. The namespace should match the GitHub organization (`cvmfs-contrib`).
+    ```bash
+    devcontainer features publish src/cvmfs --namespace cvmfs-contrib/
+    ```
+
+### Automated Publishing
+
+This repository is configured with a GitHub Actions workflow to automate this process. When a new release is published on GitHub, the workflow will automatically build and publish the feature to GHCR.
+
+For this to work, the `WRITE_PACKAGES_TOKEN` secret (a Personal Access Token with `write:packages` scope) must be configured in the repository's **Settings > Secrets and variables > Actions**.

README.md

@@ -133,6 +133,27 @@ jobs:
 
 This GitHub Action installs the [CernVM-FS package](https://cernvm.cern.ch/fs/#download), and configures it with the  `CVMFS_CLIENT_PROFILE='single'` and `CVMFS_USE_CDN='yes'` to avoid any overhead on the CernVM-FS stratum 1 servers that you are accessing, this GitHub Action uses the [OpenHTC](https://openhtc.io) caching edge servers.
 
+## Devcontainer Usage
+
+This repository includes a pre-configured devcontainer for a consistent development environment. It uses the CVMFS devcontainer feature located in the `src/cvmfs` directory.
+
+To use it, open this repository in a devcontainer-compatible editor like VS Code with the Dev Containers extension.
+
+You can add other functionalities to your devcontainer by including more features. A comprehensive list of contributed features can be found in the [devcontainer feature index](https://containers.dev/features).
+
+For example, you can add the following to your `devcontainer.json` to use this feature:
+```json
+{
+    "name": "CVMFS Action Dev",
+    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+    "features": {
+        "ghcr.io/cvmfs-contrib/features/cvmfs:1": {
+            "CVMFS_REPOSITORIES": "alice.cern.ch,atlas.cern.ch"
+        }
+    }
+}
+```
+
 ## Limitations
 
 This GitHub Action is only expected to work in workflows that [run on](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) ubuntu. There is experimental support for `macOS` (11+).

action.yml

@@ -357,7 +357,14 @@ runs:
         path: |
           ${{ inputs.apt_cache }}
     - run: |
-        ${{ github.action_path }}/setup-cvmfs.sh
+        if [ "$RUNNER_OS" == "Linux" ]; then
+          bash ${{ github.action_path }}/setup-cvmfs-linux.sh
+        elif [ "$RUNNER_OS" == "macOS" ]; then
+          bash ${{ github.action_path }}/setup-cvmfs-macos.sh
+        else
+          echo "Unsupported platform: $RUNNER_OS"
+          exit 1
+        fi
       shell: bash
       env:
         ACTION_PATH: ${{ github.action_path }}

createConfig.sh → create-config.sh

@@ -79,11 +79,11 @@ declare -a vars=(CVMFS_ALIEN_CACHE
                  CVMFS_WORKSPACE
 )
 
-sudo mkdir -p /etc/cvmfs
-echo "# cvmfs default.local file installed with cvmfs-contrib/github-action-cvmfs" | sudo tee /etc/cvmfs/default.local
+mkdir -p /etc/cvmfs
+echo "# cvmfs default.local file installed with cvmfs-contrib/github-action-cvmfs" | tee /etc/cvmfs/default.local
 for var_name in "${vars[@]}"
 do
   if [ ! -z "$(eval "echo \$$var_name")" ]; then
-    echo "$var_name='$(eval "echo \$$var_name")'" | sudo tee -a /etc/cvmfs/default.local
+    echo "$var_name='$(eval "echo \$$var_name")'" | tee -a /etc/cvmfs/default.local
   fi
 done

devcontainer-feature.json

@@ -0,0 +1,24 @@
+{
+  "name": "CVMFS",
+  "id": "cvmfs",
+  "version": "1.4.3",
+  "description": "Installs CVMFS client",
+  "options": {
+    "CVMFS_REPOSITORIES": {
+      "type": "string",
+      "default": "sft.cern.ch",
+      "description": "Comma-separated list of fully qualified repository names that shall be mountable under /cvmfs"
+    },
+    "CVMFS_CONFIG_PACKAGE": {
+      "type": "string",
+      "default": "cvmfs-config-default",
+      "description": "URL to the cvmfs config package to install"
+    },
+    "CVMFS_HTTP_PROXY": {
+      "type": "string",
+      "default": "DIRECT",
+      "description": "Chain of HTTP proxy groups used by CernVM-FS. Defaults to DIRECT)"
+    }
+  },
+  "entrypoint": "install-cvmfs-linux.sh"
+}

install-cvmfs-linux.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+# Shared CVMFS install and config logic for Linux
+set -e
+
+# Install CVMFS release package
+CVMFS_UBUNTU_DEB_LOCATION=${CVMFS_UBUNTU_DEB_LOCATION:-https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest_all.deb}
+APT_ARCHIVES=/var/cache/apt/archives/
+mkdir -p ${APT_ARCHIVES}
+if [ ! -f ${APT_ARCHIVES}/cvmfs-release-latest_all.deb ] ; then
+  curl -L -o ${APT_ARCHIVES}/cvmfs-release-latest_all.deb ${CVMFS_UBUNTU_DEB_LOCATION}
+fi
+dpkg -i ${APT_ARCHIVES}/cvmfs-release-latest_all.deb
+
+# Install CVMFS and config package
+apt-get -q update
+if [ "${CVMFS_CONFIG_PACKAGE}" == "cvmfs-config-default" ]; then
+  apt-get -q -y install cvmfs cvmfs-config-default
+else
+  curl -L -o ${APT_ARCHIVES}/cvmfs-config.deb ${CVMFS_CONFIG_PACKAGE}
+  dpkg -i ${APT_ARCHIVES}/cvmfs-config.deb
+fi
+
+# Write config from environment variables
+mkdir -p /etc/cvmfs
+
+echo "# cvmfs default.local file installed by cvmfs-install-core.sh" > /etc/cvmfs/default.local
+for var_name in $(compgen -A variable | grep ^CVMFS_)
+do
+  if [ -n "$(eval echo \$$var_name)" ]; then
+    echo "$var_name='$(eval echo \$$var_name)'" >> /etc/cvmfs/default.local
+  fi
+done
+
+# Configure CVMFS
+bash create-config.sh
+bash setup-cvmfs-config.sh
+
+# Mount repositories
+for repo in $(echo ${CVMFS_REPOSITORIES} | sed "s/,/ /g")
+do
+  sudo mount -t cvmfs ${repo} /cvmfs/${repo}
+done

setup-cvmfs-config.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+# CVMFS configuration logic
+set -e
+
+echo "::group::Running cvmfs_config setup"
+sudo cvmfs_config setup
+retConfig=$?
+if [ $retConfig -ne 0 ]; then
+  echo "!!! github-action-cvmfs FAILED !!!"
+  echo "cvmfs_config setup exited with ${retConfig}"
+  exit $retConfig
+fi
+echo "::endgroup::"

setup-cvmfs-linux.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+# Linux-specific wrapper for CI/CD or local install
+set -e
+
+# Optional: handle APT cache for CI/CD
+if [ -n "${APT_CACHE}" ]; then
+  echo "Using cache from ${APT_CACHE}"
+  mkdir -p ${APT_CACHE}/archives/ ${APT_CACHE}/lists/
+  sudo cp -r ${APT_CACHE}/archives /var/cache/apt
+  sudo cp -r ${APT_CACHE}/lists /var/lib/apt
+fi
+
+# Call shared install logic (preserve environment with configuration)
+sudo -E bash "$(dirname "$0")/install-cvmfs-linux.sh"
+
+# Optional: update cache after install
+if [ -n "${APT_CACHE}" ]; then
+  echo "Updating cache to ${APT_CACHE}"
+  mkdir -p ${APT_CACHE}/archives/ ${APT_CACHE}/lists/
+  cp /var/cache/apt/archives/*.deb ${APT_CACHE}/archives/
+  cp /var/lib/apt/lists/*_dists_* ${APT_CACHE}/lists/
+fi

setup-cvmfs-macos.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+# macOS-specific CVMFS install logic
+set -e
+
+echo "warning: MacOS support is experimental."
+
+brew tap macos-fuse-t/cask
+brew tap cvmfs/homebrew-cvmfs
+brew install cvmfs
+
+# Create /cvmfs mountpoint using synthetic firmlink
+sudo zsh -c 'echo -e "cvmfs\tUsers/Shared/cvmfs\n#comment\n" > /etc/synthetic.conf'
+sudo chown root:wheel /etc/synthetic.conf
+sudo chmod a+r /etc/synthetic.conf
+sudo /System/Library/Filesystems/apfs.fs/Contents/Resources/apfs.util -t || true
+
+# Configure CVMFS
+bash create-config.sh
+bash setup-cvmfs-config.sh
+
+# Mount repositories
+for repo in $(echo ${CVMFS_REPOSITORIES} | sed "s/,/ /g")
+do
+  mkdir -p /Users/Shared/cvmfs/${repo}
+  sudo mount -t cvmfs ${repo} /Users/Shared/cvmfs/${repo}
+done
+
+# Fuse-t can have a brief lag after mounting  before the mountpoint responds 
+sleep 3