Skip to content

Commit

Permalink
Update README with a tag-filter example so it can be used during beta
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Nordman committed Jan 16, 2019
1 parent b8b21c3 commit 90b073a
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,26 @@ This is a GitHub Action written to streamline the Ruby gem publication process.
`GITHUB_TOKEN` - Bundler needs this to create tags on your repo for the release
`RUBYGEMS_API_KEY` - The Rubygems API Key for an Owner of the Gem you wish to publish. You can find your API Key by looking in `~/.gem/credentials` or using the [Rubygems API](https://guides.rubygems.org/rubygems-org-api/#misc-methods)

# Env Options
# Environment Variables

`RELEASE_COMMAND` - By default, this will invoke `rake release` to build and publish the gem to Rubygems. Set this environment variable if you have a custom release command to be invoked

# Example

```hcl
workflow "Publish Gem" {
on = "release"
on = "push"
resolves = ["Release Gem"]
}
action "Install Dependencies" {
uses = "docker://ruby:2.6.0"
args = "bundle install"
action "Tag Filter" {
uses = "actions/bin/filter@master"
args = "tag v*"
}
action "Release Gem" {
uses = "cadwallion/publish-rubygems-action@master"
secrets = ["GITHUB_TOKEN", "RUBYGEMS_API_KEY"]
env = {
"RELEASE_COMMAND" = "rake dotenv:release"
}
needs = ["Install Dependencies"]
needs = ["Tag Filter"]
}
```

0 comments on commit 90b073a

Please sign in to comment.