Skip to content

Commit

Permalink
Reduce redundancy in README, push flag (devcontainers#179)
Browse files Browse the repository at this point in the history
  • Loading branch information
Chuxel authored Nov 4, 2022
1 parent 51ad67a commit ad6321c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# Dev Container Build and Run (devcontainers/ci)

The Dev Container Build and Run GitHub Action is aimed at making it easier to re-use [Dev Containers](https://containers.dev) in a GitHub workflow. The Action supports using a Dev Container to run commands for CI, testing, and more, along with pre-building Dev Container image. Dev Container image building supports [Dev Container Features](https://containers.dev/implementors/features/#devcontainer-json-properties) and automatically places Dev Container [metadata on an image](https://containers.dev/implementors/spec/#image-metadata) label for simplified use.
The Dev Container Build and Run GitHub Action is aimed at making it easier to re-use [Dev Containers](https://containers.dev) in a GitHub workflow. The Action supports using a Dev Container to run commands for CI, testing, and more, along with pre-building a Dev Container image. Dev Container image building supports [Dev Container Features](https://containers.dev/implementors/features/#devcontainer-json-properties) and automatically places Dev Container [metadata on an image](https://containers.dev/implementors/spec/#image-metadata) label for simplified use.

> **NOTE:** The Action is not currently capable of taking advantage of pre-built Codespaces. However, pre-built images are supported.
A similar [Azure DevOps Task](./docs/azure-devops-task.md) is also available!

Note that this project builds on top of [@devcontainers/cli](https://www.npmjs.com/package/@devcontainers/cli) which can be used in other automation systems.

## GitHub Action
The examples below show usage of the GitHub Action - see the [GitHub Action documentation](./docs/github-action.md) for more details.

> **NOTE:** This Action is not currently capable of taking advantage of pre-built Codespaces. However, pre-built images are supported.
## Quick start
Here are three examples of using the Action for common scenarios. See the [documentation](./docs/github-action.md) for more details and a list of available [inputs](./docs/github-action.md#inputs).

**Pre-building an image:**

Expand All @@ -20,7 +19,7 @@ The examples below show usage of the GitHub Action - see the [GitHub Action docu
with:
imageName: ghcr.io/example/example-devcontainer
cacheFrom: ghcr.io/example/example-devcontainer
push: true
push: always
```
**Using a Dev Container for a CI build:**
Expand All @@ -46,7 +45,7 @@ The examples below show usage of the GitHub Action - see the [GitHub Action docu
with:
imageName: ghcr.io/example/example-devcontainer
cacheFrom: ghcr.io/example/example-devcontainer
push: true
push: always
runCmd: make ci-build
```
Expand Down
4 changes: 2 additions & 2 deletions docs/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The [`devcontainers/ci` action](https://github.com/marketplace/actions/devcontai
with:
imageName: ghcr.io/example/example-devcontainer
cacheFrom: ghcr.io/example/example-devcontainer
push: true
push: always
```

**Using a Dev Container for a CI build:**
Expand All @@ -118,7 +118,7 @@ The [`devcontainers/ci` action](https://github.com/marketplace/actions/devcontai
with:
imageName: ghcr.io/example/example-devcontainer
cacheFrom: ghcr.io/example/example-devcontainer
push: true
push: always
runCmd: make ci-build
```

Expand Down

0 comments on commit ad6321c

Please sign in to comment.