From 902a745819b809d530e0d13bc3c8fa4050b93071 Mon Sep 17 00:00:00 2001 From: Ishwor Khadka Date: Wed, 14 Jun 2023 00:43:21 +0300 Subject: [PATCH] Fix README --- README.md | 21 +++++++++++++-------- package.json | 2 +- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a9b650c..9a026da 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # Docker Image Artifact Upload -Github action for uploading a docker image artifact. It leverages github action's artifact in the background to share docker image across jobs. The artifact created by each run of this action will be visible in the list of artifacts for the workflow and is prefixed with `action_image_artifact_`. For eg. docker image `foo:latest` will be uploaded as `action_image_artifact_foo_latest`. +Github action for uploading docker image artifacts. It leverages github action's artifact in the background to share docker image across jobs. The artifact created by each run of this action will be visible in the list of artifacts for the workflow and is prefixed with `action_image_artifact_`. For eg. docker image `foo:latest` will be uploaded as `action_image_artifact_foo_latest`. See [docker-image-artifact-download](https://github.com/ishworkh/docker-image-artifact-download). +# Please update you workflows to use proper semver versions introduced since v2.0.0. + ## Inputs ### `image` @@ -37,7 +39,7 @@ jobs: EOF - name: Upload image - uses: ishworkh/docker-image-artifact-upload@v1 + uses: ishworkh/docker-image-artifact-upload@v2.0.1 with: image: "test_image:latest" @@ -60,7 +62,7 @@ jobs: EOF - name: Upload image - uses: ishworkh/docker-image-artifact-upload@v1 + uses: ishworkh/docker-image-artifact-upload@v2.0.1 with: image: "test_image:latest" retention_days: "2" @@ -89,7 +91,7 @@ jobs: load: true - name: Upload image - uses: ishworkh/docker-image-artifact-upload@v1 + uses: ishworkh/docker-image-artifact-upload@v2.0.1 with: image: "test_image:latest" @@ -97,11 +99,14 @@ jobs: ## Changelogs -# `v2.0.0` +### `v2.0.0` + +- Bump `docker-image-artifact` to `v2.0.0`. +- Introduce semver versioning for github action releases. No versions with just major segment i.e `v1` will be released from now on. + +### `v1` -- Use `docker-image-artifact` to `v2.0.0`. -- Move code to `src` directory. -- Introduce new major version for the release. No single major version like `v1` will be released from now on. +- Old release ## License diff --git a/package.json b/package.json index aa2b782..f2fdbdf 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docker-image-artifact-upload", - "version": "2.0.0", + "version": "2.0.1", "description": "Github action to upload docker image as artifact to share between jobs", "scripts": { "build": "./node_modules/.bin/webpack --mode production --entry ./src/main.js --target node --output-path dist/"