{"id":18274980,"url":"https://github.com/qbaware/nilaway-action","last_synced_at":"2025-04-05T03:30:44.914Z","repository":{"id":219325795,"uuid":"748622978","full_name":"qbaware/nilaway-action","owner":"qbaware","description":"A GitHub Action that analyses Golang codebases for potential Nil panics, based on Uber's nilaway","archived":false,"fork":false,"pushed_at":"2024-04-22T10:55:29.000Z","size":513,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-22T12:03:33.043Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qbaware.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-26T11:56:43.000Z","updated_at":"2024-04-22T10:55:32.000Z","dependencies_parsed_at":"2024-01-26T19:20:10.669Z","dependency_job_id":"49d01265-5809-4563-9fe7-48173ce393b0","html_url":"https://github.com/qbaware/nilaway-action","commit_stats":null,"previous_names":["qbaware/nilaway-action"],"tags_count":10,"template":false,"template_full_name":"actions/container-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qbaware%2Fnilaway-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qbaware%2Fnilaway-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qbaware%2Fnilaway-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qbaware%2Fnilaway-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qbaware","download_url":"https://codeload.github.com/qbaware/nilaway-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247284911,"owners_count":20913691,"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-05T12:11:27.835Z","updated_at":"2025-04-05T03:30:44.021Z","avatar_url":"https://github.com/qbaware.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nilaway GitHub Action\n\n[![GitHub Super-Linter](https://github.com/qbaware/nilaway-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)\n![CI](https://github.com/qbaware/nilaway-action/actions/workflows/ci.yml/badge.svg)\n![CD](https://github.com/qbaware/nilaway-action/actions/workflows/cd.yml/badge.svg)\n\nThis is a simple GitHub Action that checks Golang codebases for potential Nil panics.\n\nUnder the hood, it uses Uber's `nilaway` static analysis tool.\nMore useful information about it can be found in [this](https://www.uber.com/en-GB/blog/nilaway-practical-nil-panic-detection-for-go/)\nUber blog post or on their GitHub [repository](https://github.com/uber-go/nilaway).\n\n## How To Use\n\n### Figure Out The Inputs\n\nAs of now, the only input is the `package-to-scan` variable.\nThis is the path to the Golang package you want to analyze.\nE.g. `./services/backend/...`.\n\n### Modify Your Action\n\nAdd the following `static-analysis` job in your Action.\n\n``` yaml\nstatic-analysis:\n  # Assuming the `build` job builds the project,\n  # we define a dependency on it.\n  needs: build\n\n  runs-on: ubuntu-latest\n  steps:\n    - name: Checkout\n      uses: actions/checkout@v3\n\n    - name: Nil panic checks\n      uses: qbaware/nilaway-action@v0\n      with:\n        package-to-scan: ./path/to/package/...\n```\n\n### That's It 🎉\n\n### Sample Workflow\n\n![sample-workflow](./resources/sample-workflow.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqbaware%2Fnilaway-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqbaware%2Fnilaway-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqbaware%2Fnilaway-action/lists"}