Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation on how to use octo #1074

Merged
merged 1 commit into from
Mar 27, 2023
Merged

Add documentation on how to use octo #1074

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
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