Skip to content

Commit

Permalink
Merge pull request #12 from ishworkh/fix_readme
Browse files Browse the repository at this point in the history
Fix README
  • Loading branch information
ishworkh authored Jun 13, 2023
2 parents 74244e3 + 902a745 commit 854182f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`
Expand Down Expand Up @@ -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"

Expand All @@ -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"
Expand Down Expand Up @@ -89,19 +91,22 @@ 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"

```

## 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

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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/"
Expand Down

0 comments on commit 854182f

Please sign in to comment.