From ea2d0c0627c742b556e46fdf9c7a2f802830f861 Mon Sep 17 00:00:00 2001 From: Yad Smood Date: Mon, 21 Mar 2022 17:11:46 +0800 Subject: [PATCH] update doc --- .github/workflows/docker.yml | 7 ++++++- .github/workflows/test-other-platforms.yml | 2 +- lib/utils/docker/main.go | 6 +++--- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index c12b2727..f3a2fd57 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -1,4 +1,9 @@ -name: Docker +# When git master branch changes it will build a image based on the master branch, the tag of the image will be latest. +# When a git semver tag is pushed it will build a image based on it, the tag will be the same as git's. +# It will do nothing on other git events. +# For the usage of the image, check lib/examples/launch-managed . + +name: Release docker image on: [push, pull_request] jobs: diff --git a/.github/workflows/test-other-platforms.yml b/.github/workflows/test-other-platforms.yml index 183941aa..2323f4c4 100644 --- a/.github/workflows/test-other-platforms.yml +++ b/.github/workflows/test-other-platforms.yml @@ -1,4 +1,4 @@ -name: Test Mac +name: Test Other Platforms on: push: branches: diff --git a/lib/utils/docker/main.go b/lib/utils/docker/main.go index 578a7bf0..5088ac7c 100644 --- a/lib/utils/docker/main.go +++ b/lib/utils/docker/main.go @@ -1,6 +1,6 @@ -// The .github/workflows/docker.yml will use it as an github action -// Then run this: -// DOCKER_TOKEN=your_token go run ./lib/utils/docker refs/heads/master +// The .github/workflows/docker.yml uses it as an github action +// and run it like this: +// DOCKER_TOKEN=$TOKEN go run ./lib/utils/docker $GITHUB_REF package main import (