Skip to content
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

Update docs to point to v0.3 release #218

Merged
merged 2 commits into from
Feb 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ The main folders in the repo are:

## Workflow

The code for both the GitHub Action and Azure DevOps Pipeline Task is written in TypeScript. Since the GitHub action is pulled from the project repo when executed, any PRs should also include the output of the build process.

To run the build step locally, run `./scripts/build.sh` from the root of the repo.
The code for both the GitHub Action and Azure DevOps Pipeline Task is written in TypeScript. To ensure that the code compiles locally, run `./scripts/build-local.sh` from the root of the repo.

The intention is for the GitHub action and Azure DevOps task to maintain feature parity as far as possible. As a general rule, and changes should be implemented in both the GitHub action and the Azure DevOps task.

Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Here are three examples of using the Action for common scenarios. See the [docum

```yaml
- name: Pre-build dev container image
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
imageName: ghcr.io/example/example-devcontainer
cacheFrom: ghcr.io/example/example-devcontainer
Expand All @@ -26,7 +26,7 @@ Here are three examples of using the Action for common scenarios. See the [docum

```yaml
- name: Run make ci-build in dev container
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
# [Optional] If you have a separate workflow like the one above
# to pre-build your container image, you can reference it here
Expand All @@ -41,7 +41,7 @@ Here are three examples of using the Action for common scenarios. See the [docum

```yaml
- name: Pre-build image and run make ci-build in dev container
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
imageName: ghcr.io/example/example-devcontainer
cacheFrom: ghcr.io/example/example-devcontainer
Expand All @@ -51,6 +51,11 @@ Here are three examples of using the Action for common scenarios. See the [docum

## CHANGELOG

### Version 0.3.0 (24th February 2023)

This version updates the release mechanism for the GitHub action so that only the compiled JavaScript is included in the release.
The primary motivation is to simplify the process for contributing to the action, but a side-benefit should be a reduced download size when using the action.

### Version 0.2.0

This version updates the implementation to use [@devcontainers/cli](https://www.npmjs.com/package/@devcontainers/cli).
Expand Down
14 changes: 7 additions & 7 deletions docs/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
uses: actions/checkout@v3

- name: Build and run dev container task
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
# Change this to be your CI task/script
runCmd: yarn test
Expand Down Expand Up @@ -62,7 +62,7 @@ jobs:
password: ${{ secrets.GITHUB_TOKEN }}

- name: Build and run Dev Container task
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
# Change this to point to your image name
imageName: ghcr.io/example/example-devcontainer
Expand All @@ -88,7 +88,7 @@ The [`devcontainers/ci` action](https://github.com/marketplace/actions/devcontai

```yaml
- name: Pre-build dev container image
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
imageName: ghcr.io/example/example-devcontainer
cacheFrom: ghcr.io/example/example-devcontainer
Expand All @@ -99,7 +99,7 @@ The [`devcontainers/ci` action](https://github.com/marketplace/actions/devcontai

```yaml
- name: Run make ci-build in dev container
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
# [Optional] If you have a separate workflow like the one above
# to pre-build your container image, you can reference it here
Expand All @@ -114,7 +114,7 @@ The [`devcontainers/ci` action](https://github.com/marketplace/actions/devcontai

```yaml
- name: Pre-build image and run make ci-build in dev container
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
imageName: ghcr.io/example/example-devcontainer
cacheFrom: ghcr.io/example/example-devcontainer
Expand Down Expand Up @@ -166,7 +166,7 @@ To build and run the dev container from `folderB` you can specify the `subFolder

```yaml
- name: Build and run dev container task
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
subFolder: folderB
imageName: ghcr.io/example/example-devcontainer
Expand All @@ -180,7 +180,7 @@ If you want to pass additional environment variables to the dev container when i

```yaml
- name: Build and run dev container task
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
env:
WORLD: World
with:
Expand Down
2 changes: 1 addition & 1 deletion docs/multi-platform-builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and release devcontainer Multi-Platform
uses: devcontainers/ci@v0.2
uses: devcontainers/ci@v0.3
with:
imageName: ghcr.io/UserNameHere/ImageNameHere
platform: linux/amd64,linux/arm64
Expand Down