Skip to content
This repository has been archived by the owner on Aug 15, 2024. It is now read-only.

Commit

Permalink
docs: guide on attaching files to github release (#769)
Browse files Browse the repository at this point in the history
also update the title of the 'adding additional files' to make it a bit
clearer that this section is 'updating additional files' and further
differentiate it from this new section.
  • Loading branch information
dwmkerr committed May 25, 2023
1 parent 8475937 commit 0a07e4a
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ jobs:
if: ${{ steps.release.outputs['packages/package-a--release_created'] }}
```

## Adding additional files
## Updating additional files

You can update additional files with the `extra-files` input.

Expand All @@ -399,6 +399,34 @@ jobs:
docs/getting-started.md
```

## Attaching files to the GitHub release

You can attach additional files, such as release artifacts, to the GitHub release that is created. The `gh` CLI tool, which is installed on all runners, can be used for this.

This example uses the `gh` tool to attach the file `./artifact/some-build-artifact.zip`:

```yaml
on:
push:
branches:
- main
name: release-please
jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: google-github-actions/release-please-action@v3
id: release
with:
release-type: node
- name: Upload Release Artifact
if: ${{ steps.release.outputs.release_created }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run:
gh release upload ${{ steps.release.outputs.tag_name }} ./artifact/some-build-artifact.zip
```

## License

Apache Version 2.0

0 comments on commit 0a07e4a

Please sign in to comment.