Skip to content

Commit

Permalink
docs: add info how to access monorepo path outputs (#1003)
Browse files Browse the repository at this point in the history
Added description how to access monorepo step result outputs using []
syntax

It took me several hours to figure out how to access the outputs of
these monorepo packages. Hopefully, this will save others some time

---------

Signed-off-by: Wolfram Sokollek <[email protected]>
Co-authored-by: Jeff Ching <[email protected]>
  • Loading branch information
WolfSoko and chingor13 authored Jun 10, 2024
1 parent 3f4784d commit 7b7ddcd
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,14 @@ This prefix allows you to distinguish values for different releases.
| `<path>--patch` | Number representing patch semver value |
| `<path>--sha` | sha that a GitHub release was tagged at |

If the path contains `/` you can access the outputs by using javascript like property access `steps.release.outputs[<path>--...]`
e.g.:

```yaml
run: npm publish --workflow packages/my-module
if: ${{ steps.release.outputs['packages/my-module--release_created'] }}
```

## How release please works

Release Please automates CHANGELOG generation, the creation of GitHub releases,
Expand Down

0 comments on commit 7b7ddcd

Please sign in to comment.