srp/go-cross-build
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 6 Wiki Activity

README.md update

Browse Source
This commit is contained in:
Uday Hiwarale 2020-04-12 02:20:01 +05:30
parent a5d76d8d5a
commit 3d5409b1f3
2 changed files with 40 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -2,8 +2,10 @@
This actions generates cross-platform executable files from a Go module. This actions generates cross-platform executable files from a Go module.
![release](/assets/release.png) ![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 ```yaml
# workflow name # workflow name
@ -33,17 +35,48 @@ jobs:
dest: 'dist' 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. 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. 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. 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. 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** #### ☉ option: **dest**
The `dest` option sets the output directory for the build files. This should be a relative directory without leading `./`. 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
```
./<dest>/
├── <name>-darwin-amd64
├── <name>-linux-amd64
├── ...
└── <name>-windows-amd64.exe
```
#### In compression mode
```
./<dest>/
├── <name>-darwin-amd64.tar.gz
| ├── <name>
| ├── LICENSE
| └── README.md
├── <name>-linux-amd64.tar.gz
| ├── <name>
| ├── LICENSE
| └── README.md
├── ...
└── <name>-windows-amd64.tar.gz
├── <name>.exe
├── LICENSE
└── README.md
```

BIN
assets/release.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 54 KiB