Bring across tag logic from #135 and update readme to include this information

Signed-off-by: Adam Warner <[email protected]>

Author: PromoFaux

.github/workflows/ftl-build.yml

@@ -7,6 +7,8 @@ on:
       - '**'
   pull_request:
   workflow_dispatch:
+  release:
+    types: [published]
   schedule:
     # 1:30am UTC every Sunday, has no particular significance
     - cron: "30 1 * * 0"
@@ -25,6 +27,7 @@ jobs:
       || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository)
       || github.event_name == 'workflow_dispatch'
       || github.event_name == 'schedule'
+      || github.event_name == 'release'
 
     outputs:
       DO_DEPLOY: ${{ steps.variables.outputs.DO_DEPLOY }}
@@ -88,12 +91,14 @@ jobs:
         ${{ needs.smoke-tests.outputs.DOCKER_REGISTRY_IMAGE }}
         ${{ needs.smoke-tests.outputs.GITHUB_REGISTRY_IMAGE }}
       # meta-tags:
-        # type=schedule means that a tag is applied when the workflow is triggered by a schedule event
-        # type=ref,event=branch means that a tag is applied when the workflow is triggered by a push to a branch
+        # type=schedule, pattern=nightly means that a "nightly" tag is applied when the workflow is triggered by a schedule event
+        # type=raw,value=nightly means that a "nightly" tag is applied when the workflow is triggerd by a push to a branch (enabled only for master branch to avoid tagging every push to other branches with "nightly")
+        # type=ref,event=branch means that a tag is applied when the workflow is triggered by a push to a branch (enabled only for non-master branches to avoid tagging every push to master branch with the branch name)
         # type=ref,event=tag means that a tag is applied when the workflow is triggered by a push to a tag
       meta-tags: |
-            type=schedule,enable=${{ github.event_name == 'schedule' }}
-            type=ref,event=branch,enable=${{ github.event_name != 'schedule' }}
+            type=schedule,pattern=nightly
+            type=raw,value=nightly,enable=${{ github.ref == 'refs/heads/master' }}
+            type=ref,event=branch,enable=${{ github.ref != 'refs/heads/master' }}
             type=ref,event=tag
       meta-flavor: |
         latest=${{ startsWith(github.ref, 'refs/tags/') }}

README.md

@@ -16,7 +16,9 @@ All images are pushed to both Docker Hub (`pihole/ftl-build`) and GHCR (`ghcr.io
 ## How does it get uploaded?
 
 - GitHub Actions (`ftl-build.yml`):
-  - Every `pull_request` event triggers a build (but does not push)
-  - Every `workflow_dispatch` event triggers a build of the branch it is run against, and uploads a branch-based tag
-  - Every `tag` event (e.g `v1`) triggers a build and uploads both `${{matrix.ARCH}}` and `v1-${{matrix.ARCH}}` tags
-  - Schedule: 1:30am UTC every Sunday a build is triggered and a `${{matrix.ARCH}}` tag is uploaded
+  - Every `pull_request` event triggers a test build (does not push)
+  - Every branch `push` (except `master`) publishes the branch name as a tag
+  - Every `workflow_dispatch` event triggers a build of the branch it is run against, and publishes the branch name as a tag
+  - Every push to `master` publishes the `nightly` tag
+  - Schedule: 1:30am UTC every Sunday a build is triggered and the `nightly` tag is published
+  - Every published GitHub `release` (e.g. `v1`) publishes the release tag and `latest`