https://github.com/ran-dall/devcontainer-features-anaconda
Project Repo for https://github.com/devcontainers/features/pull/1296
https://github.com/ran-dall/devcontainer-features-anaconda
Last synced: 3 months ago
JSON representation
Project Repo for https://github.com/devcontainers/features/pull/1296
- Host: GitHub
- URL: https://github.com/ran-dall/devcontainer-features-anaconda
- Owner: ran-dall
- License: mit
- Created: 2025-03-12T02:08:15.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T02:13:33.000Z (10 months ago)
- Last Synced: 2025-03-19T02:52:59.342Z (10 months ago)
- Language: Shell
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dev Container Features: Self Authoring Template
> This repo provides a starting point and example for creating your own custom [dev container Features](https://containers.dev/implementors/features/), hosted for free on GitHub Container Registry. The example in this repository follows the [dev container Feature distribution specification](https://containers.dev/implementors/features-distribution/).
>
> To provide feedback to the specification, please leave a comment [on spec issue #70](https://github.com/devcontainers/spec/issues/70). For more broad feedback regarding dev container Features, please see [spec issue #61](https://github.com/devcontainers/spec/issues/61).
## Distributing Features
### Versioning
Features are individually versioned by the `version` attribute in a Feature's `devcontainer-feature.json`. Features are versioned according to the semver specification. More details can be found in [the dev container Feature specification](https://containers.dev/implementors/features/#versioning).
### Publishing
> NOTE: The Distribution spec can be [found here](https://containers.dev/implementors/features-distribution/).
>
> While any registry [implementing the OCI Distribution spec](https://github.com/opencontainers/distribution-spec) can be used, this template will leverage GHCR (GitHub Container Registry) as the backing registry.
Features are meant to be easily sharable units of dev container configuration and installation code.
This repo contains a **GitHub Action** [workflow](.github/workflows/release.yaml) that will publish each Feature to GHCR.
*Allow GitHub Actions to create and approve pull requests* should be enabled in the repository's `Settings > Actions > General > Workflow permissions` for auto generation of `src//README.md` per Feature (which merges any existing `src//NOTES.md`).
By default, each Feature will be prefixed with the `` namespace. For example, the two Features in this repository can be referenced in a `devcontainer.json` with:
```
ghcr.io/ran-dall/devcontainer-features-anaconda/anaconda:1
```
The provided GitHub Action will also publish a third "metadata" package with just the namespace, eg: `ghcr.io/ran-dall/devcontainer-features-anaconda`. This contains information useful for tools aiding in Feature discovery.
### Marking Feature Public
Note that by default, GHCR packages are marked as `private`. To stay within the free tier, Features need to be marked as `public`.
This can be done by navigating to the Feature's "package settings" page in GHCR, and setting the visibility to 'public`. The URL may look something like:
```
https://github.com/users//packages/container/%2F/settings
```
### Adding Features to the Index
If you'd like your Features to appear in our [public index](https://containers.dev/features) so that other community members can find them, you can do the following:
* Go to [github.com/devcontainers/devcontainers.github.io](https://github.com/devcontainers/devcontainers.github.io)
* This is the GitHub repo backing the [containers.dev](https://containers.dev/) spec site
* Open a PR to modify the [collection-index.yml](https://github.com/devcontainers/devcontainers.github.io/blob/gh-pages/_data/collection-index.yml) file
This index is from where [supporting tools](https://containers.dev/supporting) like [VS Code Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and [GitHub Codespaces](https://github.com/features/codespaces) surface Features for their dev container creation UI.
#### Using private Features in Codespaces
For any Features hosted in GHCR that are kept private, the `GITHUB_TOKEN` access token in your environment will need to have `package:read` and `contents:read` for the associated repository.
Many implementing tools use a broadly scoped access token and will work automatically. GitHub Codespaces uses repo-scoped tokens, and therefore you'll need to add the permissions in `devcontainer.json`
An example `devcontainer.json` can be found below.
```jsonc
{
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/my-org/private-features/hello:1": {
"greeting": "Hello"
}
},
"customizations": {
"codespaces": {
"repositories": {
"my-org/private-features": {
"permissions": {
"packages": "read",
"contents": "read"
}
}
}
}
}
}
```