Skip to content

Commit

Permalink
Update README (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
at-wat committed Jan 3, 2020
1 parent 3547403 commit f69dc34
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# bloom-release-action

GitHub Action to bloom release the ROS package.
**This action is not yet ready for use. Use with very much care!**

## Inputs
<dl>
Expand All @@ -17,6 +18,33 @@ GitHub Action to bloom release the ROS package.

## Example

### Manually tag and release

```yaml
name: bloom-release
on:
push:
tags:
- '[0-9]+.[0-9]+.[0-9]+'

jobs:
bloom-release:
runs-on: ubuntu-latest
steps:
- name: bloom release
uses: at-wat/bloom-release-action@master
with:
ros_distro: kinetic melodic
github_token_bloom: ${{ secrets.GITHUB_TOKEN_BLOOM }}
github_user: @@MAINTAINER_LOGIN@@
git_email: @@MAINTAINER_EMAIL_ADDRESS@@
release_repository_push_url: https://github.com/owner/repo-release.git
```

### Automatically tag and release

Use with [at-wat/catkin-release-action](https://github.com/at-wat/catkin-release-action).

```yaml
name: bloom-release
on:
Expand Down

0 comments on commit f69dc34

Please sign in to comment.