actions/clippy
actions/clippy
3
0
Fork 0
mirror of https://github.com/giraffate/clippy-action.git synced 2024-11-24 00:49:33 +01:00
Code Issues Projects Activity Pipelines

Merge pull request #14 from giraffate/update_readme

Browse source 
Update README
This commit is contained in:
NAKATA Takayuki 2022-11-09 22:47:29 +09:00 committed by GitHub
commit 745bcdbe85
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 51 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

130
README.md
View file

@ -1,105 +1,77 @@
<p align="center"> # GitHub Action: Run Clippy with reviewdog
<a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
</p>
# 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. ```yml
name: clippy-action
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) on: [pull_request]
env:
## Create an action from this template CARGO_TERM_COLOR: always
jobs:
Click the `Use this Template` and provide the new repo details for your action clippy:
runs-on: ubuntu-latest
## Code in Main steps:
- uses: actions/checkout@v3
> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance. - name: Install latest nightly
uses: actions-rs/toolchain@v1
Install the dependencies with:
```bash toolchain: nightly
$ npm install 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: ## Inputs
```bash
$ npm test
PASS ./index.test.js ### `github_token`
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
... **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 `<clippy_flags>`)
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 ### `workdir`
import * as core from '@actions/core';
...
async function run() { Optional. Working directory relative to the root directory.
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}
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: ### `fail_on_error`
```bash
$ npm run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```
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)) Optional. Install a specific version of reviewdog.
By default, the latest version of reviewdog is installed.
```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