{"id":18293755,"url":"https://github.com/withfig/push-to-fig-autocomplete-action","last_synced_at":"2025-04-05T11:31:17.545Z","repository":{"id":37858228,"uuid":"466487460","full_name":"withfig/push-to-fig-autocomplete-action","owner":"withfig","description":"Action to automatically open a new PR to the https://github.com/withfig/autocomplete repo","archived":false,"fork":false,"pushed_at":"2024-03-22T19:51:09.000Z","size":178391,"stargazers_count":11,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-16T00:18:10.005Z","etag":null,"topics":["actions","autocomplete","devops","fig","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/withfig.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2022-03-05T15:11:57.000Z","updated_at":"2024-05-30T21:22:37.100Z","dependencies_parsed_at":"2024-03-22T20:31:03.139Z","dependency_job_id":"9458e14e-ed5d-4ef1-8517-47b661674f63","html_url":"https://github.com/withfig/push-to-fig-autocomplete-action","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fpush-to-fig-autocomplete-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fpush-to-fig-autocomplete-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fpush-to-fig-autocomplete-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fpush-to-fig-autocomplete-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/withfig","download_url":"https://codeload.github.com/withfig/push-to-fig-autocomplete-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247330676,"owners_count":20921676,"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":["actions","autocomplete","devops","fig","typescript"],"created_at":"2024-11-05T14:26:01.434Z","updated_at":"2025-04-05T11:31:16.590Z","avatar_url":"https://github.com/withfig.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/actions/typescript-action/actions\"\u003e\u003cimg alt=\"typescript-action status\" src=\"https://github.com/actions/typescript-action/workflows/build-test/badge.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Usage\n\n```yml\nname: \"Publish version\"\non:\n  push:\n    tags:\n      - \"v*\"\n  workflow_dispatch:\n\njobs:\n  push-to-fig-autocomplete:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - uses: actions/setup-node@v2\n      - name: Generate the spec\n        run:\n          ## Execute commands to generate the spec through some official or third party integration\n      - name:\n          Create Autocomplete PR\n          ## Create the autocomplete PR using this action\n        uses: withfig/publish-to-fig-autocomplete@v2\n        with:\n          token: ${{ secrets.YOUR_PAT_HERE }}\n          autocomplete-spec-name: generated-spec\n          spec-path: path/to/generated-spec.ts\n          integration: commander\n  ## Other jobs not related to the spec update\n```\n\n### Supported Inputs\n\n- `token`: a GitHub personal access token with repo scope (default: `GITHUB_TOKEN`)\n- `autocomplete-spec-name` (required): the name of the spec in the autocomplete repo in the form `[scope/]name` where name is the spec filename in the autocomplete repo. Examples:\n  - if the spec relative path in the autocomplete repo is `src/npm.ts`, then `autocomplete-spec-name` is `npm`\n  - if the spec relative path in the autocomplete repo is `src/@withfig/autocomplete-tools.ts`, then `autocomplete-spec-name` is `@withfig/autocomplete-tools`\n- `spec-path` (required): the path of the generated spec in the current repo\n- `spec-folder-path`: The path to an additional folder with specs in the repo, used for very large specs which use `loadSpec`\n- `integration`: the name of the official Fig integration used [See](https://fig.io/docs/guides/autocomplete-for-teams). Supported values: `\"commander\" | \"oclif\" | \"cobra\" | \"clap\" | \"swift-argument-parser\" | \"click\" | \"cement\" | \"argparse\"`\n- `pr-body`: set a custom PR body description\n\nWe also provide support for third party autocomplete repos via the following inputs:\n\n- `repo-org`: name of the organization/user that stores the third party autocomplete repository (default: `withfig`)\n- `repo-name`: name of the third party autocomplete repository (default: `autocomplete`)\n- `diff-based-versioning`: use new diff-based versioning (default: false) (**requires**: `new-spec-version` to be set if `diff-based-versioning` is true)\n- `new-spec-version`: the new spec version (only required when using diff-based-versioning)\n- `use-minor-base`: create a new version file per each minor version (only used with diff-based-versioning) (default: `false`)\n\n\u003e NOTE: third party autocomplete repos must be structured as the official autocomplete one. Run `npx @withfig/autocomplete-tools@latest init` to generate one.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithfig%2Fpush-to-fig-autocomplete-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwithfig%2Fpush-to-fig-autocomplete-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithfig%2Fpush-to-fig-autocomplete-action/lists"}