{"id":18352642,"url":"https://github.com/chipsalliance/verible-linter-action","last_synced_at":"2025-04-09T09:08:30.221Z","repository":{"id":37900983,"uuid":"399399609","full_name":"chipsalliance/verible-linter-action","owner":"chipsalliance","description":"Automatic SystemVerilog linting in github actions with the help of Verible","archived":false,"fork":false,"pushed_at":"2024-10-23T07:37:41.000Z","size":51,"stargazers_count":33,"open_issues_count":3,"forks_count":14,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-02T02:26:41.965Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chipsalliance.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-24T09:00:32.000Z","updated_at":"2025-02-03T16:06:00.000Z","dependencies_parsed_at":"2024-01-07T12:18:50.008Z","dependency_job_id":"3d4887f2-9851-4289-bd82-9cf776bc1052","html_url":"https://github.com/chipsalliance/verible-linter-action","commit_stats":{"total_commits":41,"total_committers":8,"mean_commits":5.125,"dds":0.7073170731707317,"last_synced_commit":"fffe5143d07ba3149c6cefc78c89a4abe9d7e961"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chipsalliance%2Fverible-linter-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chipsalliance%2Fverible-linter-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chipsalliance%2Fverible-linter-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chipsalliance%2Fverible-linter-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chipsalliance","download_url":"https://codeload.github.com/chipsalliance/verible-linter-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248008630,"owners_count":21032556,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T21:36:41.887Z","updated_at":"2025-04-09T09:08:30.202Z","avatar_url":"https://github.com/chipsalliance.png","language":"Python","funding_links":[],"categories":["Programming Languages"],"sub_categories":[],"readme":"# Verible Linter Action\n\nThis action uses [Verible](https://github.com/chipsalliance/verible) to identify coding style issues in SystemVerilog code.\n\n![verible linter action](https://user-images.githubusercontent.com/8438531/140962421-0a51e7b8-dc1c-4f87-b84b-1c2f3462cfca.png)\n\n## Usage\n\nSee [action.yml](action.yml)\n\nThis is a GitHub Action used to lint Verilog and SystemVerilog source files\nand comment erroneous lines of code in Pull Requests automatically.\nThe GitHub Token input is used to provide\n[reviewdog](https://github.com/reviewdog/reviewdog)\naccess to the PR.\nIf you don't wish to use the automatic PR review,\nyou can omit the ``github_token`` input.\nIf you'd like to use a reporter of reviewdog other than ``github-pr-review``,\nyou can pass its name in the input ``reviewdog_reporter``.\nIf you want to declare Verible version to be used,\nyou can pass its release tag in the input ``verible_version``.\n\nHere's a basic example to lint all ``*.v`` and ``*.sv`` files:\n```yaml\nname: Verible linter example\non:\n  pull_request:\njobs:\n  lint:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@master\n    - uses: chipsalliance/verible-linter-action@main\n      with:\n        github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n\nYou can provide optional arguments to specify paths, exclude paths, extensions of tested files,\na config file, Verible version and extra arguments for ``verible-verilog-lint``.\n\n```yaml\n- uses: chipsalliance/verible-linter-action@main\n  with:\n    config_file: 'config.rules'\n    paths: |\n      ./rtl\n      ./shared\n    exclude_paths: |\n      ./rtl/some_file\n    extra_args: \"--check_syntax=true\"\n    verible_version: \"v0.0-3100-gd75b1c47\"\n    extensions: |\n      .sv\n      .v\n      .vh\n      .svh\n    github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Automatic review on PRs from external repositories\n\nIn GitHub Actions, workflows triggered by external repositories may only have\n[read access to the main repository](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token).\nIn order to have automatic reviews on external PRs, you need to change your workflow to trigger\non ``pull_request_target`` event and manually check out changes from pull request:\n\n```yaml\n\nname: Verible linter example\non:\n  pull_request_target:\n\njobs:\n  lint:\n    runs-on: ubuntu-latest\n    permissions:\n      checks: write\n      contents: read\n      pull-requests: write\n    steps:\n      - uses: actions/checkout@v3\n        with:\n          ref: ${{ github.event.pull_request.head.sha }}\n      - name: Run Verible action\n        uses: chipsalliance/verible-linter-action@main\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchipsalliance%2Fverible-linter-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchipsalliance%2Fverible-linter-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchipsalliance%2Fverible-linter-action/lists"}