-
Notifications
You must be signed in to change notification settings - Fork 12
feat: Add devcontainer feature and update setup script for CVMFS #51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
wdconinc
wants to merge
3
commits into
main
Choose a base branch
from
feat/devcontainer-feature
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: Publish Devcontainer Feature | ||
|
||
on: | ||
release: | ||
types: [created] | ||
|
||
jobs: | ||
publish: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v5 | ||
|
||
- 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="${{ 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 }} |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# CVMFS Devcontainer Feature | ||
|
||
This directory contains a devcontainer feature for installing and configuring the CVMFS client. The definition is located in the top-level directory to allow reuse of the GitHub Actions scripts. | ||
|
||
## 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 --namespace cvmfs-contrib/github-action-cvmfs . | ||
``` | ||
|
||
### 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**. |
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{ | ||
"name": "CVMFS", | ||
"id": "cvmfs", | ||
"version": "0.0.0", | ||
"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" | ||
} |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is not really a way to build the feature locally, build a dev container locally, and test it locally (which is weird; it's just docker stuff with a wrapper).