Skip to content

Commit

Permalink
use latest on semver and snapshot on every master branch update
Browse files Browse the repository at this point in the history
Signed-off-by: Avi Deitcher <[email protected]>
  • Loading branch information
deitch authored and rvs committed Apr 21, 2021
1 parent 4380ce9 commit 9fb03a1
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,5 @@ jobs:
tags: |
${{env.IMAGE_NAME}}:${{github.sha}}
${{env.IMAGE_NAME}}:0.0.${{github.run_number}}
${{env.IMAGE_NAME}}:snapshot
1 change: 1 addition & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ jobs:
push: true
tags: |
${{env.IMAGE_NAME}}:${{env.GITHUB_REF#refs/tags/}}
${{env.IMAGE_NAME}}:latest
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,22 @@ $ adam <cmd>
$ docker run <cmd>
```

### Image Tagging

Every commit to the `master` branch of Adam releases an image to docker hub. These are tagged with the git commit. In addition, the most recent
commit is tagged with `snapshot`, i.e. `lfedge/adam:snapshot`.

Adam regularly releases proper [semantic versioned](https://semver.org) releases, with images tagged as `vx.y.z`, e.g. `v1.2.3`. The highest numbered,
most recent release is tagged with `latest`.

* `lfedge/adam:latest` (or just `lfedge/adam`) - most recent release
* `lfedge/adam:v1.2.3` - release 1.2.3
* `lfedge/adam:snapshot` - most recent commit to mainline branch
* `lfedge/adam:6aa76a1ac3ee46aefd96525190e4bd4eb4f5d828` - build from commit `6aa76a1ac3ee46aefd96525190e4bd4eb4f5d828`

For all of the sample commands in this guide, we use simply `lfedge/adam`, equivalent to `lfedge/adam:latest`. You should feel free to
replace `latest` with whichever tag is appropriate for your use case.

## Pre-Requisites

In addition to adam itself - as a local binary or docker container - you need the following:
Expand Down

0 comments on commit 9fb03a1

Please sign in to comment.