{"id":47640556,"url":"https://github.com/qualcomm/armor-checkers","last_synced_at":"2026-04-14T13:01:28.914Z","repository":{"id":336657608,"uuid":"1143464170","full_name":"qualcomm/armor-checkers","owner":"qualcomm","description":null,"archived":false,"fork":false,"pushed_at":"2026-04-08T07:08:30.000Z","size":128,"stargazers_count":0,"open_issues_count":2,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-08T09:02:47.167Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause-clear","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qualcomm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-27T16:03:10.000Z","updated_at":"2026-04-08T06:51:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"f19cb697-5c20-4939-886f-1997c81034d9","html_url":"https://github.com/qualcomm/armor-checkers","commit_stats":null,"previous_names":["qualcomm/armor-checkers"],"tags_count":4,"template":false,"template_full_name":"qualcomm/qualcomm-repository-template","purl":"pkg:github/qualcomm/armor-checkers","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qualcomm%2Farmor-checkers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qualcomm%2Farmor-checkers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qualcomm%2Farmor-checkers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qualcomm%2Farmor-checkers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qualcomm","download_url":"https://codeload.github.com/qualcomm/armor-checkers/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qualcomm%2Farmor-checkers/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31797376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T11:13:53.975Z","status":"ssl_error","status_checked_at":"2026-04-14T11:13:53.299Z","response_time":153,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-04-02T00:51:05.742Z","updated_at":"2026-04-14T13:01:28.888Z","avatar_url":"https://github.com/qualcomm.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# armor-checkers\nReusable GitHub Actions and workflows for validating backward compatibility in Qualcomm C/C++ projects.\nThe repository provides modular API (source‑level) and ABI (binary‑level) compatibility checks to help detect api breaking changes early in CI and ensure stable releases.\n\n### Overview\n*   **API Compatibility Check:** Detects source‑level breaking changes (e.g., modified/removed functions, structs, enums) using the ARMOR tool https://github.com/qualcomm/armor.\n*   **ABI Compatibility Check:** Validates binary‑level stability using libabigail (abidiff), detecting issues such as:\n\n    * Layout or padding changes\n    * Symbol additions/removals\n    * Incompatible binary interface changes\n\n### Features\n* Reusable GitHub Actions and workflows\n* Automatic API/ABI comparison between base and head commits\n* Works with any C/C++ project exposing public headers and build scripts\n* Extensible design for future compatibility‑related checks\n\n### Usage\nCreate a workflow (e.g., .github/workflows/compatibility-check.yml):\n\n    name: Compatibility Checks\n\n    on:\n      pull_request:\n        types: [opened, synchronize, reopened]\n\n\n    jobs:\n      armor-checkers:\n        uses: qualcomm/armor-checkers/.github/workflows/armor-checker.yml@v2\n        with:\n          armor-checker-options: \u003e-\n            {\n            \"build-script\": \"ci/build.sh\",\n\n            // Optional: Use runner groups / self‑hosted runner labels\n            \"runs-on\": {\n                \"group\": \"\",\n                \"labels\": [\"\", \"\"]\n            }\n\n            // Or use a simple GitHub-hosted runner (default)\n            // \"runs-on\": \"ubuntu-latest\"\n            }\n\nThis integrates automatic API/ABI backward‑compatibility validation into your CI pipeline.\n\n### Configuration options\n `armor-checker-options` is a JSON parameter passed to the reusable workflow. It controls how API/ABI checks run.\n * **Supported fields:**\n* `build-script` **(required for ABI checks)**\n   * Specifies the script path that builds the project and generates binaries for ABI comparison.\n   * Default: ci/build.sh\n   * Update if the build script path changes\n\n* `runs-on` **(required for API \u0026 ABI)**\n   * Defines which runner to execute the checks on.\n   * If your project already uses AWS self‑hosted runners,it is **recommended** to use them for armor-checkers, because they provide the necessary access for ARMOR Checkers workflow to upload API/ABI metrics to the S3 bucket.\n   * If omitted, GitHub‑hosted runners are used by default; however, in this case ARMOR Checkers cannot upload API/ABI metrics to the S3 bucket.\n```\n      \"runs-on\": {\n        \"group\": \"aws-runner-group\",\n        \"labels\": [\"label1\", \"label2\"]\n      }\n```\n## License\n\narmor-checkers is licensed under the [BSD-3-Clause-Clear License](https://spdx.org/licenses/BSD-3-Clause-Clear.html). See [LICENSE.txt](LICENSE.txt) for the full license text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualcomm%2Farmor-checkers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqualcomm%2Farmor-checkers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualcomm%2Farmor-checkers/lists"}