Skip to content

Feature: Allow for cli version specification #253

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.

Sign up for GitHub

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
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Feature: Allow for cli version specification #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
43d6d5f
allow for cli version specification
Olgethorpe Jul 27, 2023
b1b980f
have local passing build
Olgethorpe Jul 27, 2023
ff84ddf
address review comment & add docs
Olgethorpe Jul 28, 2023
cf25e32
PR feedback
Olgethorpe Dec 20, 2023
5cbd013
Merge branch 'main' into main
chrmarti Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@
"name": "devcontainers-ci",
"dockerFile": "Dockerfile",
"build": {
"cacheFrom": "ghcr.io/devcontainers/ci-devcontainer:latest"
"cacheFrom": "ghcr.io/devcontainers/ci-devcontainer:latest",
"args": {
// This is a temporary workaround when developing from host -> remote host -> devcontainer
// see: https://github.com/microsoft/vscode-remote-release/issues/7958
"BUILDKIT_INLINE_CACHE": "0"
}
},
"mounts": [
// Keep command history
Expand Down
4 changes: 4 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ inputs:
required: false
default: false
description: Builds the image with `--no-cache` (takes precedence over `cacheFrom`)
cliVersion:
required: false
default: latest
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the default now 0?

description: The version of the devcontainer CLI to use
cacheTo:
required: false
description: Specify the image to cache the built image to
Expand Down
13 changes: 11 additions & 2 deletions azdo-task/DevcontainersCi/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
DevContainerCliBuildArgs,
DevContainerCliExecArgs,
DevContainerCliUpArgs,
MAJOR_VERSION_FALLBACK
} from '../../../common/src/dev-container-cli';

import {isDockerBuildXInstalled, pushImage} from './docker';
Expand All @@ -23,10 +24,18 @@ export async function runMain(): Promise<void> {
);
return;
}
const devContainerCliInstalled = await devcontainer.isCliInstalled(exec);
const specifiedDevContainerCliVersion =
task.getInput('cliVersion') ?? MAJOR_VERSION_FALLBACK;
const devContainerCliInstalled = await devcontainer.isCliInstalled(
exec,
specifiedDevContainerCliVersion,
);
if (!devContainerCliInstalled) {
console.log('Installing @devcontainers/cli...');
const success = await devcontainer.installCli(exec);
const success = await devcontainer.installCli(
exec,
specifiedDevContainerCliVersion,
);
if (!success) {
task.setResult(
task.TaskResult.Failed,
Expand Down
3 changes: 2 additions & 1 deletion azdo-task/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ In the example above, the devcontainer-build-run will perform the following step
| cacheFrom | false | Specify additional images to use for build caching |
| noCache | false | Builds the image with `--no-cache` (takes precedence over `cacheFrom`) |
| cacheTo | false | Specify the image to cache the built image to |
| platform | false | Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated. |
| platform | false | Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated. |
| cliVersion | false | The version of the [devcontainers CLI](https://github.com/devcontainers/cli) to use |

## Outputs

Expand Down
14 changes: 6 additions & 8 deletions common/src/dev-container-cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {promisify} from 'util';
import {ExecFunction} from './exec';
import {findWindowsExecutable} from './windows';

const cliVersion = "0"; // Use 'latest' to get latest CLI version, or pin to specific version e.g. '0.14.1' if required
export const MAJOR_VERSION_FALLBACK = '0';
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Use camelCase.


export interface DevContainerCliError {
outcome: 'error';
Expand All @@ -26,19 +26,17 @@ function getSpecCliInfo() {
};
}

async function isCliInstalled(exec: ExecFunction): Promise<boolean> {
async function isCliInstalled(exec: ExecFunction, cliVersion: string): Promise<boolean> {
try {
const command = await findWindowsExecutable(getSpecCliInfo().command);
const {exitCode} = await exec(command, ['--help'], {
silent: true,
});
return exitCode === 0;
const {exitCode, stdout} = await exec(command, ['--version'], {});
return exitCode === 0 && stdout.trim() === cliVersion;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

=== won't match, e.g., major version 0 with any actual x.y.z version. 🤔

} catch (error) {
return false;
}
}
const fstat = promisify(fs.stat);
async function installCli(exec: ExecFunction): Promise<boolean> {
async function installCli(exec: ExecFunction, cliVersion: string): Promise<boolean> {
// if we have a local 'cli' folder, then use that as we're testing a private cli build
let cliStat = null;
try {
Expand All @@ -54,7 +52,7 @@ async function installCli(exec: ExecFunction): Promise<boolean> {
}
return exitCode === 0;
}
console.log('** Installing @devcontainers/cli');
console.log(`** Installing @devcontainers/cli@${cliVersion}`);
const {exitCode, stdout, stderr} = await exec('bash', ['-c', `npm install -g @devcontainers/cli@${cliVersion}`], {});
if (exitCode != 0) {
console.log(stdout);
Expand Down
3 changes: 2 additions & 1 deletion docs/azure-devops-task.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ In the example above, the devcontainer-build-run will perform the following step
| cacheFrom | false | Specify additional images to use for build caching |
| noCache | false | Builds the image with `--no-cache` (takes precedence over `cacheFrom`) |
| cacheTo | false | Specify the image to cache the built image to |
| platform | false | Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated. |
| platform | false | Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated. |
| cliVersion | false | The version of the [devcontainers CLI](https://github.com/devcontainers/cli) to use |

## Outputs

Expand Down
3 changes: 2 additions & 1 deletion docs/github-action.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ The [`devcontainers/ci` action](https://github.com/marketplace/actions/devcontai
| cacheFrom | false | Specify additional images to use for build caching |
| noCache | false | Builds the image with `--no-cache` (takes precedence over `cacheFrom`) |
| cacheTo | false | Specify the image to cache the built image to |
| platform | false | Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated. |
| platform | false | Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated. |
| cliVersion | false | The version of the [devcontainers CLI](https://github.com/devcontainers/cli) to use |

## Outputs

Expand Down
13 changes: 11 additions & 2 deletions github-action/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
DevContainerCliBuildArgs,
DevContainerCliExecArgs,
DevContainerCliUpArgs,
MAJOR_VERSION_FALLBACK
} from '../../common/src/dev-container-cli';

import {isDockerBuildXInstalled, pushImage} from './docker';
Expand All @@ -33,10 +34,18 @@ export async function runMain(): Promise<void> {
);
return;
}
const devContainerCliInstalled = await devcontainer.isCliInstalled(exec);
const specifiedDevContainerCliVersion =
core.getInput('cliVersion') ?? MAJOR_VERSION_FALLBACK;
const devContainerCliInstalled = await devcontainer.isCliInstalled(
exec,
specifiedDevContainerCliVersion,
);
if (!devContainerCliInstalled) {
core.info('Installing @devcontainers/cli...');
const success = await devcontainer.installCli(exec);
const success = await devcontainer.installCli(
exec,
specifiedDevContainerCliVersion,
);
if (!success) {
core.setFailed('@devcontainers/cli install failed!');
return;
Expand Down