-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Goact Documentation | ||
|
||
Goact is a command-line tool (CLI) that enables you to create pipeline stacks to automate workflows on GitHub Actions. | ||
|
||
## Installation | ||
|
||
To use Goact, follow the steps below to install it on your system: | ||
|
||
1. Download the Goact source code or clone the GitHub repository. | ||
|
||
2. Navigate to the Goact project directory. | ||
|
||
3. Compile the Goact code to create the executable: | ||
|
||
```bash | ||
go build | ||
``` | ||
|
||
Move the executable to a folder that is in your system's PATH: | ||
|
||
```bash | ||
sudo mv goact /usr/local/bin | ||
``` | ||
|
||
## Usage | ||
|
||
Goact is designed to make it easy to create pipeline stacks in GitHub Actions. With the create command, you can configure GitHub Actions and generate essential files for your actions. | ||
|
||
## Command create | ||
|
||
The create command is used to create the GitHub Actions configuration for a specific pipeline stack. | ||
|
||
```bash | ||
goact create --stack <STACK_NAME> | ||
``` | ||
|
||
Replace <STACK_NAME> with the name of the stack you want to create, for example, node.js, python, java, golang or ruby. | ||
|
||
```bash | ||
goact create --stack node.js | ||
``` |