|
| 1 | +# .github/workflows/rubocop.yml |
| 2 | + |
| 3 | +name: YARD |
| 4 | + |
| 5 | +on: [push, pull_request] |
| 6 | + |
| 7 | +jobs: |
| 8 | + build: |
| 9 | + runs-on: ubuntu-latest |
| 10 | + |
| 11 | + steps: |
| 12 | + - uses: actions/checkout@v2 |
| 13 | + - name: Set up Ruby 3.0.2 |
| 14 | + uses: actions/setup-ruby@v1 |
| 15 | + with: |
| 16 | + ruby-version: 3.0.2 # Replace with your ruby version |
| 17 | + - name: Gems Cache |
| 18 | + id: gem-cache |
| 19 | + uses: actions/cache@v1 |
| 20 | + with: |
| 21 | + path: vendor/bundle |
| 22 | + key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }} |
| 23 | + restore-keys: | |
| 24 | + ${{ runner.os }}-gem- |
| 25 | + - name: Add YARD |
| 26 | + run: bundle add yard |
| 27 | + - name: Install |
| 28 | + run: bundle install |
| 29 | + - name: Run Yard |
| 30 | + run: yard doc -m markdown -o docs --exclude app/main.rb |
| 31 | + - uses: EndBug/add-and-commit@v7 # You can change this to use a specific version. |
| 32 | + with: |
| 33 | + # The arguments for the `git add` command (see the paragraph below for more info) |
| 34 | + # Default: '.' |
| 35 | + add: '*' |
| 36 | + |
| 37 | + # The name of the custom committer you want to use, if different from the author of the commit. |
| 38 | + # Default: the name of the author (set with either author_name or default_author) |
| 39 | + committer_name: GitHub Actions |
| 40 | + |
| 41 | + # The email of the custom committer you want to use, if different from the author of the commit. |
| 42 | + # Default: the email of the author (set with either author_email or default_author) |
| 43 | + committer_email: actions@github.com |
| 44 | + |
| 45 | + # The local path to the directory where your repository is located. You should use actions/checkout first to set it up. |
| 46 | + # Default: '.' |
| 47 | + cwd: '.' |
| 48 | + |
| 49 | + # Determines the way the action fills missing author name and email. Three options are available: |
| 50 | + # - github_actor -> UserName <UserName@users.noreply.github.com> |
| 51 | + # - user_info -> Your Display Name <your-actual@email.com> |
| 52 | + # - github_actions -> github-actions <email associated with the github logo> |
| 53 | + # Default: github_actor |
| 54 | + default_author: github_actions |
| 55 | + |
| 56 | + # The message for the commit. |
| 57 | + # Default: 'Commit from GitHub Actions (name of the workflow)' |
| 58 | + message: 'Generate new YARD docs' |
| 59 | + |
| 60 | + # The way the action should handle pathspec errors from the add and remove commands. Three options are available: |
| 61 | + # - ignore -> errors will be logged but the step won't fail |
| 62 | + # - exitImmediately -> the action will stop right away, and the step will fail |
| 63 | + # - exitAtEnd -> the action will go on, every pathspec error will be logged at the end, the step will fail. |
| 64 | + # Default: ignore |
| 65 | + pathspec_error_handling: ignore |
| 66 | + |
| 67 | + # Arguments for the git pull command. Use NO-PULL to avoid the action pulling at all. |
| 68 | + # Default: '--no-rebase' |
| 69 | + pull: '--no-rebase' |
| 70 | + |
| 71 | + # Whether to push the commit and, if any, its tags to the repo. It can also be used to set the git push arguments (see the paragraph below for more info) |
| 72 | + # Default: true |
| 73 | + push: true |
| 74 | + |
| 75 | + # The arguments for the `git rm` command (see the paragraph below for more info) |
| 76 | + # Default: '' |
| 77 | + remove: '' |
| 78 | + |
| 79 | + # Whether to use the --signoff option on `git commit` (only boolean values accepted*) |
| 80 | + # Default: false |
| 81 | + signoff: false |
| 82 | + |
| 83 | + # Arguments for the git tag command (the tag name always needs to be the first word not preceded by an hyphen) |
| 84 | + # Default: '' |
| 85 | + tag: '' |
| 86 | + |
0 commit comments