diff --git a/README.md b/README.md index 39da8d4..2306140 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,10 @@ This actions generates cross-platform executable files from a Go module. ![release](/assets/release.png) +> Automatic release management of the [**tree**](https://github.com/thatisuday/tree/releases) CLI tool using **go-build-action** action. -# Workflow setup + +## Workflow setup ```yaml # workflow name @@ -33,17 +35,48 @@ jobs: dest: 'dist' ``` -### option: **platforms** +#### ☉ option: **platforms** The `platforms` option specifies comma-separated platform names to create binary-executable files for. To see the list of supported platforms, use `go tool dist list` command. -### option: **package** +#### ☉ option: **package** If the module (_repository_) itself is a Go package, then `package` option value should be an empty string (''). If the repository contains a package directory, then `package` value should be the directory name. -### option: **compress** +#### ☉ option: **compress** The `compress` option if set to `'true'` will generate **compressed-tar** archive files for the each platform-build file. The resulting archive file also contains `README.md` and `LICENSE` file if they exist inside the root of the repository. In this mode, the binary executable file name is taken from the `name` option value. -### option: **name** +#### ☉ option: **name** The `name` option sets a prefix for the build filenames. In compression mode, this prefix is applied to archive files and binary executable filename is set to this value. -### option: **dest** -The `dest` option sets the output directory for the build files. This should be a relative directory without leading `./`. \ No newline at end of file +#### ☉ option: **dest** +The `dest` option sets the output directory for the build files. This should be a relative directory without leading `./`. + + +## Build Artifacts +This action produces following build-artifacts. + +#### In non-compression mode +``` +.// + ├── -darwin-amd64 + ├── -linux-amd64 + ├── ... + └── -windows-amd64.exe +``` + +#### In compression mode +``` +.// + ├── -darwin-amd64.tar.gz + | ├── + | ├── LICENSE + | └── README.md + ├── -linux-amd64.tar.gz + | ├── + | ├── LICENSE + | └── README.md + ├── ... + └── -windows-amd64.tar.gz + ├── .exe + ├── LICENSE + └── README.md +``` diff --git a/assets/release.png b/assets/release.png index 8e194ae..2d1623a 100644 Binary files a/assets/release.png and b/assets/release.png differ