Skip to content

Commit

Permalink
use fetch-depth 0 for version tagging with git describe; add getting …
Browse files Browse the repository at this point in the history
…section to README
  • Loading branch information
jessepeterson committed Sep 18, 2023
1 parent 173bc38 commit 17863c5
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/on-push-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ jobs:
packages: write
steps:
- uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b # v3.2.0
with:
fetch-depth: 0

- uses: docker/login-action@465a07811f14bebb1938fbed4728c6a1ff8901fc # v2.2.0
with:
Expand Down Expand Up @@ -68,6 +70,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b # v3.2.0
with:
fetch-depth: 0

- uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 # v3.5.0
with:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/on-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ jobs:
contents: write
steps:
- uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b # v3.2.0
with:
fetch-depth: 0

- uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 # v3.5.0
with:
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ A guide to get NanoDEP up and running quickly.
- [Operations Guide](docs/operations-guide.md)
A brief overview of the various tools and utilities for working with NanoDEP.

## Getting the latest version

* Release `.zip` files containing the project should be attached to every [GitHub release](https://github.com/micromdm/nanodep/releases).
* Release zips are also [published](https://github.com/micromdm/nanodep/actions) for every `main` branch commit.
* A Docker container is built and [published to the GHCR.io registry](http://ghcr.io/micromdm/nanodep) for every release.
* `docker pull ghcr.io/micromdm/nanodep:latest``docker run ghcr.io/micromdm/nanodep:latest`
* A Docker container is also published for every `main` branch commit (and tagged with `:main`)
* If you have a [Go toolchain installed](https://go.dev/doc/install) you can checkout the source and simply run `make`.

## Tools and utilities

NanoDEP contains a few tools and utilities. At a high level:
Expand Down

0 comments on commit 17863c5

Please sign in to comment.