Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use latest on semver and snapshot on every master branch update #86

Merged
merged 1 commit into from
Apr 21, 2021
Merged

use latest on semver and snapshot on every master branch update #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/publish.yaml
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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