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.

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

Update README #1

Merged
merged 1 commit into from
Jan 3, 2020
Merged
Changes from all commits
Commits
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
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