diff --git a/.github/workflows/hugo.yml b/.github/workflows/hugo.yml index 3f97b954..d46c6b63 100644 --- a/.github/workflows/hugo.yml +++ b/.github/workflows/hugo.yml @@ -1,8 +1,10 @@ name: Publish Hugo Documentation On New Tag on: push: -# branches: + branches: # - master +# Update for given branch for one of releases, otherwise only release on tags + - feature/fixingReleaseDocs tags: - v* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e460df7d..fa61be53 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,9 +1,10 @@ name: Release GDG on Tag -on: - create: - tags: - - '*' - +on: + push: +# branches: +# - master + tags: + - v* jobs: goreleaser: diff --git a/.goreleaser.yml b/.goreleaser.yml index 966fced0..4e5a2037 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -29,7 +29,7 @@ builds: - CGO_ENABLED=0 binary: gdg-generate ldflags: -s -w -X github.com/esnet/gdg/internal/version.GitCommit={{ .Commit }} -X github.com/esnet/gdg/internal/version.BuildDate={{ .Date }} -X github.com/esnet/gdg/internal/version.Version={{ .Tag }} - main: ./cmd/gen + main: ./cmd/gdg-generate goos: - linux - windows diff --git a/Taskfile.yml b/Taskfile.yml index 4e6b655a..a0862abe 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -67,7 +67,7 @@ tasks: desc: "Buiding {{ .BIN_NAME }}-generate {{ .VERSION }}" cmds: - echo "GOPATH=${GOPATH}" - - go build -ldflags "{{ .LD_FLAGS }}" -o bin/{{ .BIN_NAME }}-generate cmd/gen/main.go + - go build -ldflags "{{ .LD_FLAGS }}" -o bin/{{ .BIN_NAME }}-generate cmd/gdg-generate/main.go install: desc: "installing {{ .BIN_NAME }} {{ .VERSION }}" cmds: diff --git a/cmd/gen/main.go b/cmd/gdg-generate/main.go similarity index 100% rename from cmd/gen/main.go rename to cmd/gdg-generate/main.go diff --git a/website/content/en/docs/gdg/installation.md b/website/content/en/docs/gdg/installation.md index 3f76e270..d35e835e 100644 --- a/website/content/en/docs/gdg/installation.md +++ b/website/content/en/docs/gdg/installation.md @@ -17,8 +17,8 @@ The following packages are currently supported: Install from package involves downloading the appropriate package from the [release](https://github.com/esnet/gdg/releases) and installing it as you usually do on your favorite Distro. ```sh -rpm -Uvh ./gdg_0.5.1_amd64.rpm -dpkg -i ./gdg_0.5.1_amd64.deb +rpm -Uvh ./gdg_0.5.3_amd64.rpm +dpkg -i ./gdg_0.5.3_amd64.deb ``` ### Homebrew Installation @@ -43,7 +43,7 @@ The docker tags are released started with 0.3.1. Each release will generate a m You can see the available images [here](https://github.com/esnet/gdg/pkgs/container/gdg) ```sh -docker pull ghcr.io/esnet/gdg:0.5.1 +docker pull ghcr.io/esnet/gdg:0.5.3 ``` NOTE: ghcr.io/esnet/gdg:0.3 will also point to 0.3.1 until 0.3.2 is released after which it'll point to 0.3.2 @@ -54,7 +54,7 @@ Example compose. version: '3.7' services: gdg: - image: ghcr.io/esnet/gdg:0.5.1 + image: ghcr.io/esnet/gdg:0.5.3 command: "--help" ## Add additional parameters here # command: "ds export" ## Pass any cmd on here. volumes: @@ -70,15 +70,29 @@ docker run -it --rm -v $(pwd)/config:/app/config -v $(pwd)/exports:/app/exports ### Installing via Go -If you have go install you may run the following command to install gdg +If you have go install you may run the following command to install gdg. Keep in mind there are two binaries you may install. +- gdg ==> Main binary that manages the various entities supported. +- gdg-generate => Helper utility that allows you to generate multiple dashboards given a valid configuration and seed data. + +--- + +**gdg** ```sh -go install github.com/esnet/gdg@latest #for latest -go install github.com/esnet/gdg@v0.5.1 #for a specific version +go install github.com/esnet/gdg/cmd/gdg@latest #for latest +go install github.com/esnet/gdg/cmd/gdg@v0.5.3 #for a specific version ``` You can verify the version by running `gdg version`. +**gdg-generate** +```sh +go install github.com/esnet/gdg/cmd/gen@latest #for latest +go install github.com/esnet/gdg/cmd/gen@v0.5.3 #for a specific version +``` + +--- + ## Configuration You can then create a simple configuration using `gdg tools ctx new` which will do a best effort to guide to setup a basic config that will get you up and going or read the more detailed documentation that can be found [here](/gdg/docs/gdg/configuration/)