{"id":38833423,"url":"https://github.com/mx51/data-dictionary-action","last_synced_at":"2026-01-17T13:54:13.426Z","repository":{"id":46830842,"uuid":"404907139","full_name":"mx51/data-dictionary-action","owner":"mx51","description":"GitHub Action for generating and checking freshness of data dictionaries","archived":false,"fork":false,"pushed_at":"2025-11-24T03:20:27.000Z","size":55,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-11-24T05:30:30.685Z","etag":null,"topics":["action","analytics","data"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":false,"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/mx51.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-10T00:21:23.000Z","updated_at":"2025-11-24T03:20:28.000Z","dependencies_parsed_at":"2024-04-29T00:29:47.878Z","dependency_job_id":"e0e33f45-bdac-4e00-b1fa-ba7d553f0d66","html_url":"https://github.com/mx51/data-dictionary-action","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mx51/data-dictionary-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mx51%2Fdata-dictionary-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mx51%2Fdata-dictionary-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mx51%2Fdata-dictionary-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mx51%2Fdata-dictionary-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mx51","download_url":"https://codeload.github.com/mx51/data-dictionary-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mx51%2Fdata-dictionary-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28509441,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T13:38:16.342Z","status":"ssl_error","status_checked_at":"2026-01-17T13:37:44.060Z","response_time":85,"last_error":"SSL_read: 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":["action","analytics","data"],"created_at":"2026-01-17T13:54:12.803Z","updated_at":"2026-01-17T13:54:13.419Z","avatar_url":"https://github.com/mx51.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# data-dictionary-action\n\nGitHub Action for generating and checking freshness of `data.json` data dictionaries.\n\n## Inputs\n\n* `store-name` - Name of the data store.\n* `store-type` - Type of the data store.\n    - [`postgres`](https://www.postgresql.org/)\n* `tool-type` - Type of the data tool (e.g. migration).\n    - [`rubenv-sql-migrate`](https://github.com/rubenv/sql-migrate)\n* `tool-path` - Path to the data tool files (e.g. migration).\n* `proto-path` - Path to services proto files.\n* `dictionary-app-id` - Dictionary GitHub App ID.\n* `dictionary-app-private-key` - Dictionary GitHub App private key.\n* `dictionary-repo` - Dictionary repo name. Defaults to `data-dictionary`.\n* `dictionary-ref` - Dictionary branch reference. Defaults to `master`.\n* `dictionary-workflow` - Dictionary workflow name. Defaults to `build.yml`.\n* `repo-token` - GitHub auth token for pull request comments (NOT for commits). Defaults to `${{ github.token }}`.\n\n## Example\n\nBelow is an example recommended GitHub Actions workflow:\n\n```yaml\non:\n  pull_request:\n    types: [opened, reopened, synchronize]\n    branches:\n      - master\n    paths:\n      - \"schema/**\"\n      - \"data.json\"\n\njobs:\n  tag:\n    runs-on: ubuntu-latest\n    name: data-dictionary\n    steps:\n      - uses: actions/checkout@v2\n        with:\n          ref: ${{ github.event.pull_request.head.ref }}\n          fetch-depth: 2\n\n      - uses: mx51/data-dictionary-action@master\n        with:\n          store-name: my-store-name\n          store-type: postgres\n          tool-type: rubenv-sql-migrate\n          tool-path: schema\n          dictionary-app-id: ${{ secrets.DATA_DICTIONARY_APP_ID }}\n          dictionary-app-private-key: ${{ secrets.DATA_DICTIONARY_APP_PRIVATE_KEY }}\n```\n\n## Development\n\nFor local development, ensure the following are installed:\n\n- Docker\n- Python 3.10+\n\nThe following environment variables are required to be set (e.g. `.env` file):\n\n- `GITHUB_REPOSITORY` - org/repo that you are testing against (see [default environment variables](https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables))\n- `GITHUB_WORKSPACE` - path to directory you are testing against (see [default environment variables](https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables))\n- `STORE_NAME` (see `inputs.store-name`)\n- `STORE_TYPE` (see `inputs.store-type`)\n- `TOOL_TYPE` (see `inputs.tool-type`)\n- `TOOL_PATH` (see `inputs.tool-path`)\n\nIf you want to test Git actions (committing and pushing changes), set the following variables as well:\n\n- `GITHUB_TOKEN` (see `inputs.repo-token`)\n- `GITHUB_PULL` (see `github.event.pull_request.number`)\n\nOnce everything is set, execute the action script:\n\n```shell\nmake run\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmx51%2Fdata-dictionary-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmx51%2Fdata-dictionary-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmx51%2Fdata-dictionary-action/lists"}