Update docs to point to v0.3 release (devcontainers#218)

* Update docs references to use v0.3 * Update CONTRIBUTING.md
frikke · Feb 24, 2023 · 3e5d540 · 3e5d540
1 parent 2f2e700
commit 3e5d540
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 14 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -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.
 

diff --git a/README.md b/README.md
@@ -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
@@ -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
@@ -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
@@ -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).

diff --git a/docs/github-action.md b/docs/github-action.md
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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:

diff --git a/docs/multi-platform-builds.md b/docs/multi-platform-builds.md
@@ -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