From 5b32d0eb6f3f7100da516c8bc0716df108d84907 Mon Sep 17 00:00:00 2001 From: Anthony Dahanne Date: Mon, 27 Mar 2023 17:36:11 -0400 Subject: [PATCH] Add documentation on how to use octo * it should be run from the .github folder --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 80e24291..c3e0573c 100644 --- a/README.md +++ b/README.md @@ -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 +``` + +...or run directly using Go. ```shell $: go run github.com/paketo-buildpacks/pipeline-builder/cmd/octo --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