diff --git a/README.md b/README.md index fac1dd6..033d021 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,77 @@ -

- typescript-action status -

+# GitHub Action: Run Clippy with reviewdog -# Create a JavaScript Action using TypeScript +This action runs [Clippy](https://github.com/rust-lang/rust-clippy) with +[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve code review experience. -Use this template to bootstrap the creation of a TypeScript action.:rocket: +## Example usage -This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance. - -If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) - -## Create an action from this template - -Click the `Use this Template` and provide the new repo details for your action - -## Code in Main - -> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance. - -Install the dependencies -```bash -$ npm install +```yml +name: clippy-action +on: [pull_request] +env: + CARGO_TERM_COLOR: always +jobs: + clippy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Install latest nightly + uses: actions-rs/toolchain@v1 + with: + toolchain: nightly + override: true + components: rustfmt, clippy + - name: clippy-action + uses: giraffate/clippy-action@main + with: + reporter: 'github-pr-review' + github_token: ${{ secrets.GITHUB_TOKEN }} ``` -Build the typescript and package it for distribution -```bash -$ npm run build && npm run package -``` -Run the tests :heavy_check_mark: -```bash -$ npm test +## Inputs - PASS ./index.test.js - ✓ throws invalid number (3ms) - ✓ wait 500 ms (504ms) - ✓ test runs (95ms) +### `github_token` -... -``` +**Required**. Default is `${{ github.token }}`. -## Change action.yml +### `clippy_flags` -The action.yml defines the inputs and output for your action. +Optional. clippy flags. (cargo clippy --color never -q --message-format json ``) -Update the action.yml with your name, description, inputs and outputs for your action. +### `tool_name` -See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions) +Optional. Tool name to use for reviewdog reporter. Useful when running multiple actions with different config. -## Change the Code +### `level` -Most toolkit and CI/CD operations involve async operations so the action is run in an async function. +Optional. Report level for reviewdog [info,warning,error]. +It's same as `-level` flag of reviewdog. -```javascript -import * as core from '@actions/core'; -... +### `workdir` -async function run() { - try { - ... - } - catch (error) { - core.setFailed(error.message); - } -} +Optional. Working directory relative to the root directory. -run() -``` +### `reporter` -See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages. +Optional. Reporter of reviewdog command [github-pr-check,github-pr-review]. +It's same as `-reporter` flag of reviewdog. -## Publish to a distribution branch +### `filter_mode` -Actions are run from GitHub repos so we will checkin the packed dist folder. +Optional. Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. +Default is added. -Then run [ncc](https://github.com/zeit/ncc) and push the results: -```bash -$ npm run package -$ git add dist -$ git commit -a -m "prod dependencies" -$ git push origin releases/v1 -``` +### `fail_on_error` -Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project. +Optional. Exit code for reviewdog when errors are found [`true`, `false`] +Default is `false`. -Your action is now published! :rocket: +### `reviewdog_flags` -See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) +Optional. Additional reviewdog flags -## Validate +### `reviewdog_version` -You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml)) - -```yaml -uses: ./ -with: - milliseconds: 1000 -``` - -See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket: - -## Usage: - -After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action +Optional. Install a specific version of reviewdog. +By default, the latest version of reviewdog is installed.