Ruby GitHub actions guidelines

What the Action does

The action runs with the GitHub release. The action installs dependencies, runs tests, and publishes gem to Rubygems.

Notes

  • It's recommended to use Linux machine for building - jobs.<name>.runs-on property.
  • For publishing, the action uses 3rd party dawidd6/action-publish-gem@v1 action.
  • The SDK uses GitHub releases.

GitHub Action example

  • Build test and publish gem to Rubygems
name: publish-gem

on:
  release:
    types: [published]

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Set up Ruby
      uses: ruby/setup-ruby@v1
      with:
        ruby-version: 2.6
    - name: Install dependencies
      run: bundle install
    - name: Run tests
      run: bundle exec rake
    - name: Publish gem
      uses: dawidd6/action-publish-gem@v1
      with:
        api_key: $