GitHub Actions

Public
Automate, customize, and execute your software development workflows right in your repository with GitHub Actions.
Used 85 times
• Created by
V Viktor Schmidt
Usage
Combine actions in a completely customized workflow.
https://docs.github.com/en/actions

Run this command in your Rails app directory in the terminal:

rails app:template LOCATION="https://railsbytes.com/script/VAjsY8"
Template Source

Review the code before running this template on your machine.

def print_green(heredoc)
  puts set_color heredoc, :green
end

def do_commit
  git :init
  git add: "."
  Bundler.with_unbundled_env { git commit: " -m 'Setup GitHub Actions' " }
end

say "Setuping GitHub Actions..."
# PR
create_file ".github/workflows/pr_labeler.yml" do
  <<~RUBY 
  name: PR Labeler
  on:
    pull_request:
      types: [opened]
  permissions:
    contents: read

  jobs:
    pr-labeler:
      name: PR Labeler
      runs-on: ubuntu-latest
      permissions:
        contents: read
        pull-requests: write

      steps:
        - uses: TimonVS/pr-labeler-action@v5
          timeout-minutes: 10
          with:
            configuration-path: .github/config/pr_labeler.yml
          env:
            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  RUBY
end

create_file ".github/config/pr_labeler.yml" do
  <<~RUBY 
  feature: feature/*
  bugfix: ["bug/*", "bugfix/*", "hotfix/*", "fix/*"]
  improvement: improvement/*
  RUBY
end

if Rails.version < "7.2"
  unless File.exist? ".github/workflows/ci.yml"
    create_file ".github/workflows/ci.yml" do 
      <<~RUBY 
        name: CI

        on:
          pull_request:
            branches: [ main, master ]
          push:
            branches: [ main, master ]

        jobs:
          scan_ruby:
            runs-on: ubuntu-latest

            steps:
              - name: Checkout code
                uses: actions/checkout@v4

              - name: Set up Ruby
                uses: ruby/setup-ruby@v1
                with:
                  ruby-version: .ruby-version
                  bundler-cache: true

              - name: Scan for security vulnerabilities in Ruby dependencies
                timeout-minutes: 10
                run: bin/brakeman --no-pager

          lint:
            runs-on: ubuntu-latest

            steps:
              - name: Checkout code
                uses: actions/checkout@v4

              - name: Set up Ruby
                uses: ruby/setup-ruby@v1
                with:
                  ruby-version: .ruby-version
                  bundler-cache: true

              - name: Lint code for consistent style
                timeout-minutes: 10
                run: bin/rubocop -f github

          test:
            runs-on: ubuntu-latest

            services:
              postgres:
                image: postgres
                env:
                  POSTGRES_USER: postgres
                  POSTGRES_PASSWORD: postgres
                ports:
                  - 5432:5432
                options: --health-cmd="pg_isready" --health-interval=10s --health-timeout=5s --health-retries=3

              # redis:
              #   image: redis
              #   ports:
              #     - 6379:6379
              #   options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5

            steps:
              - name: Install packages
                run: sudo apt-get update && sudo apt-get install --no-install-recommends -y google-chrome-stable curl libjemalloc2 libvips postgresql-client libpq-dev

              - name: Checkout code
                uses: actions/checkout@v4

              - name: Set up Ruby
                uses: ruby/setup-ruby@v1
                with:
                  ruby-version: .ruby-version
                  bundler-cache: true

              - name: Run tests
                timeout-minutes: 10
                env:
                  RAILS_ENV: test
                  COVERAGE: true
                  RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
                  DATABASE_URL: postgres://postgres:postgres@localhost:5432
                  # REDIS_URL: redis://localhost:6379/0
                run: bin/rails db:test:prepare test test:system

              - name: Keep screenshots from failed system tests
                timeout-minutes: 10
                uses: actions/upload-artifact@v4
                if: failure()
                with:
                  name: screenshots
                  path: ${{ github.workspace }}/tmp/screenshots
                  if-no-files-found: ignore
      RUBY
    end
  end
end

# uncomment_lines ".github/workflows/ci.yml", "redis"
# Uncomment each line individually, because `uncomment_lines` does not work
gsub_file(".github/workflows/ci.yml", /^(\s*)#[[:blank:]]?(.*redis:)/, '\1\2')
gsub_file(".github/workflows/ci.yml", /^(\s*)#[[:blank:]]?(.*image: redis)/, '\1\2')
gsub_file(".github/workflows/ci.yml", /^(\s*)#[[:blank:]]?(.*ports:)/, '\1\2')
gsub_file(".github/workflows/ci.yml", /^(\s*)#[[:blank:]]?(.*\- 6379:6379)/, '\1\2')
gsub_file(".github/workflows/ci.yml", /^(\s*)#[[:blank:]]?(.*redis-cli ping)/, '\1\2')

# https://hub.docker.com/_/memcached
if File.exist?("config/initializers/memcached.rb") || yes?("Would you like to add Memcached service?")
  memcached = <<~RUBY.indent(6) 

      memcached:
        image: memcached:1.6
        ports:
          - 11211:11211
  RUBY

  inject_into_file ".github/workflows/ci.yml", after: /REDIS_URL.*\n/  do
    <<~RUBY.indent(10)
      MEMCACHIER_SERVERS: localhost
    RUBY
  end

  inject_into_file ".github/workflows/ci.yml", after: /redis-cli.*\n/  do
    memcached
  end
end

if Rails.version > "6" && File.exist?("package.json")
  setup_yarn = <<~RUBY.indent(6)

      - name: Set up Node and Yarn
        uses: actions/setup-node@v4
        with:
          node-version-file: '.node-version'
          cache: yarn

      - name: Install Yarn dependencies
        run: yarn install --frozen-lockfile

      - name: Build JavaScript packs
        run: yarn build

      - name: Build CSS packs
        run: yarn build:css
  RUBY

  inject_into_file ".github/workflows/ci.yml", before: /\n.*Run tests/ do
    setup_yarn
  end
end

if File.exist?(".env.template") || File.exist?(".env.example")
  setup_variables = <<~RUBY.indent(6) 

      - name: Load dev environment variables
        uses: cardinalby/export-env-action@v2
        with:
          envFile: #{File.exist?(".env.template") ? ".env.template" : ".env.example"}
          expandWithJobEnv: true
  RUBY

  inject_into_file ".github/workflows/ci.yml", before: /\n.*Run tests/  do
    setup_variables
  end
end

if File.exist?(".env.test")
  setup_test_variables = <<~RUBY.indent(6)

      - name: Load test environment variables
        uses: cardinalby/export-env-action@v2
        with:
          envFile: .env.test
          expandWithJobEnv: true
  RUBY

  inject_into_file ".github/workflows/ci.yml", before: /\n.*Run tests/  do
    setup_test_variables
  end
end


# Legal
append_file ".github/workflows/ci.yml" do
  <<~RUBY.indent(2)

  scan_legal:
    runs-on: ubuntu-latest

    env:
      BUNDLE_PATH: "vendor/bundle"

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: .ruby-version

      - name: Cache gems
        uses: actions/cache@v4
        with:
          path: vendor/bundle
          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
          restore-keys: |
            ${{ runner.os }}-gems-

      - name: Install Ruby dependencies
        run: bundle install
  RUBY
end

if Rails.version > "6" && File.exist?("package.json")
  append_file ".github/workflows/ci.yml" do
    <<~RUBY.indent(6)

      - name: Set up Node and Yarn
        uses: actions/setup-node@v4
        with:
          node-version-file: .node-version
          cache: yarn

      - name: Install Yarn dependencies
        run: yarn install --frozen-lockfile
    RUBY
  end
end

append_file ".github/workflows/ci.yml" do
  <<~RUBY.indent(6)

    - name: Check for unapproved licenses
      timeout-minutes: 10
      run: bin/license_finder --format text
  RUBY
end

create_file ".github/dependabot.yml" do
  <<~YML 
    version: 2
    updates:
    - package-ecosystem: bundler
      directory: "/"
      schedule:
        interval: weekly
      open-pull-requests-limit: 5
      versioning-strategy: increase-if-necessary
      groups:
        development-dependencies:
          dependency-type: "development"
        bundler-patch:
          patterns:
            - "*"
          update-types:
            - patch
        bundler-minor:
          patterns:
            - "*"
          exclude-patterns:
            - "rails"
          update-types:
            - minor
        bundler-major-security-updates:
          applies-to: security-updates
          patterns:
            - "*"
          exclude-patterns:
            - "rails"
          update-types:
            - major
        bundler-major-version-updates:
          applies-to: version-updates
          patterns:
            - "*"
          exclude-patterns:
            - "rails"
          update-types:
            - major
      ignore:
        - dependency-name: "rails"
          update-types:
            - version-update:semver-major
            - version-update:semver-minor
    - package-ecosystem: npm
      directory: "/"
      schedule:
        interval: weekly
      open-pull-requests-limit: 5
      versioning-strategy: increase-if-necessary
      groups:
        development-dependencies:
          dependency-type: "development"
        npm-patch:
          patterns:
            - "*"
          update-types:
            - patch
        npm-minor:
          patterns:
            - "*"
          update-types:
            - minor
        npm-major-security-updates:
          applies-to: security-updates
          patterns:
            - "*"
          exclude-patterns:
            - "bootstrap"
          update-types:
            - major
        npm-major-version-updates:
          applies-to: version-updates
          patterns:
            - "*"
          exclude-patterns:
            - "bootstrap"
          update-types:
            - major
      ignore:
        - dependency-name: "bootstrap"
          update-types:
            - version-update:semver-major
    - package-ecosystem: github-actions
      directory: "/"
      schedule:
        interval: weekly
      open-pull-requests-limit: 3
  YML
end

run "bin/rubocop -AS"
do_commit

print_green "\nSetuped GitHub Actions successfully!"
Comments
Viktor Schmidt
You should use dependabot, see https://github.com/rails/rails/pull/50536. Dependabot is now included in default Rails GitHub CI files, see https://github.com/rails/rails/pull/50508