{"id":15063822,"url":"https://github.com/kleidukos/diff-package-api","last_synced_at":"2025-04-10T11:25:53.157Z","repository":{"id":249531032,"uuid":"831763244","full_name":"Kleidukos/diff-package-api","owner":"Kleidukos","description":"Workflow to have golden tests on your Haskell package's API","archived":false,"fork":false,"pushed_at":"2024-12-06T13:53:32.000Z","size":11,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T08:51:29.246Z","etag":null,"topics":["golden-test","haskell","stability"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kleidukos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-07-21T15:02:10.000Z","updated_at":"2024-12-09T23:35:19.000Z","dependencies_parsed_at":"2024-07-21T16:47:27.666Z","dependency_job_id":"816d11bd-9028-4772-a355-fce1a5e5bebc","html_url":"https://github.com/Kleidukos/diff-package-api","commit_stats":null,"previous_names":["kleidukos/diff-package-api"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kleidukos%2Fdiff-package-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kleidukos%2Fdiff-package-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kleidukos%2Fdiff-package-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kleidukos%2Fdiff-package-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kleidukos","download_url":"https://codeload.github.com/Kleidukos/diff-package-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208621,"owners_count":21065203,"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":["golden-test","haskell","stability"],"created_at":"2024-09-25T00:07:39.396Z","updated_at":"2025-04-10T11:25:53.139Z","avatar_url":"https://github.com/Kleidukos.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# diff-package-api\n\n## Usage\n\nInstall the appropriate version of [print-api](https://github.com/Kleidukos/print-api) in your development environment and build your project with GHC environment files enabled:\n\n```bash\n$ cabal build --write-ghc-environment-files=always\n```\n\nThen produce the human-readable API summary with the command:\n\n```bash\n$ print-api -p \u003cyour-package\u003e\n```\n\nAnd save the output to a file in the repository. You will track this file so that the workflow may compare\nits results during CI with this canonical file.\n\nIn your Workflow file, add the `--write-ghc-environment-files=always` option to your `cabal build` line, and after build and tests have passed, add:\n\n```yaml\n- name: Diff the expected and actual package APIs\n  uses: kleidukos/diff-package-api@v0.1.0.1\n  with:\n    package-name: \u003cmy-package\u003e\n    expected-interface: \u003cthe path where you track the canonical interface file\u003e\n    ghc: \u003cThe GHC version you use in CI\u003e\n    version: 0.1.0.1 # This is the version of the print-api tool\n```\n\nIf you use a job matrix, the value of the `ghc:` parameter may be `${{ matrix.ghc }}`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkleidukos%2Fdiff-package-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkleidukos%2Fdiff-package-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkleidukos%2Fdiff-package-api/lists"}