No project description provided
Project description
Devcontainers Contrib CLI
Installation
pip install devcontainer-contrib[generate]
Feature Generation:
Usage: python -m devcontainer_contrib features generate [OPTIONS]
FEATURE_DEFINITION
OUTPUT_DIR
Arguments:
FEATURE_DEFINITION [required]
OUTPUT_DIR [required]
Options:
--help Show this message and exit.
Input for feature generation is a feature-definition.json
file
This is an extended version of the devcontainer-feature.json file with additional fields:
{
...
regular devcontainer-json fields like id, name, description etc
...
# dependencies are list of features and options (those will be installed as prerequisites to your feature)
"dependencies": [
{
"feature": "ghcr.io/devcontainers-contrib/features/asdf-package:latest",
"options": {
"plugin": "act",
"version": "latest"
}
}
],
# This command will be executed after the dependency feature list has been installed
"install_command": "echo 'Done'",
# this example test scenario checks the default options (empty options dict), each test_command should exit wth code `0` if your feature is installed correctly.
"test_scenarios": [
{
"name": "test_defaults",
"image": "mcr.microsoft.com/devcontainers/base:debian",
"test_commands": [
"act --version"
],
"options": {}
}
]
}
redirect input
{
...
"options": {
"version": {
"type": "string",
"default": "latest",
"description": "Select the version of act to install."
}
},
# you can also redirect one of your actual devcontainer-feature.json options values into a dependency input, note the `$options.version` pointer to the asdf-package version option
"dependencies": [
{
"feature": "ghcr.io/devcontainers-contrib/features/asdf-package:latest",
"options": {
"plugin": "act",
"version": "$options.version"
}
}
],
...
}
Usage example
this will generate the Elixir feature It assumes you have the devcontainer-contrib cli already installed
git clone https://github.com/devcontainers-contrib/cli --depth 1
cd cli
devcontainer-contrib features generate "./test/resources/test_feature_definitions/elixir-asdf/feature-definition.json" "./output_dir"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for devcontainer_contrib-0.0.26-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e124d9b07acb58db19a139c7b8be3396190e6453f430818989fcd7b0c421b8aa |
|
MD5 | 490a85d5db063a92324886f24ed1f840 |
|
BLAKE2b-256 | 0f20586ca1919b6da8fb4cd280c468c46eadde614157b9c87641af6bab78ae91 |