action template

Aktionsvorlage

Dies ist ein Vorlagen-Repository für Reviewdog-Aktionen mit Release-Automatisierung. Klicken Sie auf die Schaltfläche Use this template um Ihre Reviewdog-Aktion zu erstellen?!

Wenn Sie Ihre eigene Reviewdog-Aktion von Grund auf erstellen möchten, ohne diese Vorlage zu verwenden, überprüfen und kopieren Sie bitte den Release-Automatisierungsablauf. Es ist wichtig, den Release-Workflow zu verwalten und die Reviewdog-Version für alle Reviewdog-Aktionen zu synchronisieren.

Dieses Repo enthält eine Beispielaktion zum Ausführen von Rechtschreibfehlern.

Eingang

 inputs :
  github_token :
    description : ' GITHUB_TOKEN '
    default : ' ${{ github.token }} '
  workdir :
    description : ' Working directory relative to the root directory. '
    default : ' . '
  # ## Flags for reviewdog ###
  level :
    description : ' Report level for reviewdog [info,warning,error] '
    default : ' error '
  reporter :
    description : ' Reporter of reviewdog command [github-pr-check,github-check,github-pr-review]. '
    default : ' github-pr-check '
  filter_mode :
    description : |
      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    default : ' added '
  fail_on_error :
    description : |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    default : ' false '
  reviewdog_flags :
    description : ' Additional reviewdog flags '
    default : ' '
  # ## Flags for <linter-name> ###
  locale :
    description : ' -locale flag of misspell. (US/UK) '
    default : ' ' 

Verwendung

 name : reviewdog
on : [pull_request]
jobs :
  # TODO: change `linter_name`.
  linter_name :
    name : runner / <linter-name>
    runs-on : ubuntu-latest
    steps :
      - uses : actions/checkout@v4
      - uses : reviewdog/action-template@v1
        with :
          github_token : ${{ secrets.github_token }}
          # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
          reporter : github-pr-review
          # Change reporter level if you need.
          # GitHub Status Check won't become failure with warning.
          level : warning 

Entwicklung

Freigeben

haya14busa/action-bumpr

Sie können die Version beim Zusammenführen von Pull Requests mit bestimmten Bezeichnungen (bump:major,bump:minor,bump:patch) erhöhen. Es funktioniert auch, das Tag selbst manuell zu verschieben.

haya14busa/action-update-semver

Diese Aktion aktualisiert Haupt-/Nebenversions-Tags bei einem Tag-Push. Aktualisieren Sie beispielsweise das Tag v1 und v1.2, wenn Version 1.2.3 veröffentlicht wird. Ref: https://help.github.com/en/articles/about-actions#versioning-your-action

Lint – Reviewdog-Integration

Diese Reviewdog-Aktionsvorlage selbst ist in Reviewdog integriert, um Lints auszuführen, was für Docker-Container-basierte Aktionen nützlich ist.

Unterstützte Linters:

• reviewdog/action-shellcheck
• reviewdog/action-hadolint
• reviewdog/action-mispell

Automatisierung der Abhängigkeitsaktualisierung

Dieses Repository verwendet reviewdog/action-depup, um die Reviewdog-Version zu aktualisieren.