From 17863c55b34f557c96923d3b346e739432342421 Mon Sep 17 00:00:00 2001 From: Jesse Peterson Date: Mon, 18 Sep 2023 09:17:06 -0700 Subject: [PATCH] use fetch-depth 0 for version tagging with git describe; add getting section to README --- .github/workflows/on-push-pr.yml | 4 ++++ .github/workflows/on-release.yml | 2 ++ README.md | 9 +++++++++ 3 files changed, 15 insertions(+) diff --git a/.github/workflows/on-push-pr.yml b/.github/workflows/on-push-pr.yml index 04269d6..8ae92a4 100644 --- a/.github/workflows/on-push-pr.yml +++ b/.github/workflows/on-push-pr.yml @@ -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: @@ -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: diff --git a/.github/workflows/on-release.yml b/.github/workflows/on-release.yml index cb7b141..9843d5d 100644 --- a/.github/workflows/on-release.yml +++ b/.github/workflows/on-release.yml @@ -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: diff --git a/README.md b/README.md index bcd9e14..4cef236 100644 --- a/README.md +++ b/README.md @@ -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: