Skip to content

Commit

Permalink
Merge pull request #1074 from anthonydahanne/add-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
dmikusa authored Mar 27, 2023
2 parents 0eb01e6 + 5b32d0e commit 719dfec
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,24 @@ The Pipeline Builder is a collection of tools related to GitHub Actions and othe
Octo Pipelines is a CLI that generates a collection of GitHub Workflows and other Github-related artifacts in a repository. The pipeline generator takes a simplified descriptor as input and transforms it into more complicated workflows and artifacts.

### Getting Started
The command line can either be built or run directly using Go.
The command line can either be built...

```shell
$: go build -o octo-bin -ldflags="-s -w" cmd/octo/main.go
$: sudo mv octo-bin /usr/local/bin/octo
$: cd ~/path-to/paketo-buildpacks/azul-zulu/.github
$: octo --descriptor <DESCRIPTOR>
```

...or run directly using Go.

```shell
$: go run github.com/paketo-buildpacks/pipeline-builder/cmd/octo --descriptor <DESCRIPTOR>
```

**Make sure you run Octo from the `.github` folder where the descriptor file is**


The input is a YAML-based descriptor, examples of which can be found in `.github/pipeline-descriptor.yml` in other repositories.

### Common Workflows
Expand Down

0 comments on commit 719dfec

Please sign in to comment.