https://github.com/withfig/push-to-fig-autocomplete-action

Action to automatically open a new PR to the https://github.com/withfig/autocomplete repo
https://github.com/withfig/push-to-fig-autocomplete-action

actions autocomplete devops fig typescript

Last synced: about 2 months ago
JSON representation

Action to automatically open a new PR to the https://github.com/withfig/autocomplete repo

• Host: GitHub
• URL: https://github.com/withfig/push-to-fig-autocomplete-action
• Owner: withfig
• License: mit
• Created: 2022-03-05T15:11:57.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-22T19:51:09.000Z (9 months ago)
• Last Synced: 2024-04-16T00:18:10.005Z (9 months ago)
• Topics: actions, autocomplete, devops, fig, typescript
• Language: TypeScript
• Homepage:
• Size: 170 MB
• Stars: 11
• Watchers: 2
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



## Usage

```yml

name: "Publish version"

on:

  push:

    tags:

      - "v*"

  workflow_dispatch:

jobs:

  push-to-fig-autocomplete:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - uses: actions/setup-node@v2

      - name: Generate the spec

        run:

          ## Execute commands to generate the spec through some official or third party integration

      - name:

          Create Autocomplete PR

          ## Create the autocomplete PR using this action

        uses: withfig/publish-to-fig-autocomplete@v2

        with:

          token: ${{ secrets.YOUR_PAT_HERE }}

          autocomplete-spec-name: generated-spec

          spec-path: path/to/generated-spec.ts

          integration: commander

  ## Other jobs not related to the spec update

```

### Supported Inputs

- `token`: a GitHub personal access token with repo scope (default: `GITHUB_TOKEN`)

- `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:

  - if the spec relative path in the autocomplete repo is `src/npm.ts`, then `autocomplete-spec-name` is `npm`

  - if the spec relative path in the autocomplete repo is `src/@withfig/autocomplete-tools.ts`, then `autocomplete-spec-name` is `@withfig/autocomplete-tools`

- `spec-path` (required): the path of the generated spec in the current repo

- `spec-folder-path`: The path to an additional folder with specs in the repo, used for very large specs which use `loadSpec`

- `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"`

- `pr-body`: set a custom PR body description

We also provide support for third party autocomplete repos via the following inputs:

- `repo-org`: name of the organization/user that stores the third party autocomplete repository (default: `withfig`)

- `repo-name`: name of the third party autocomplete repository (default: `autocomplete`)

- `diff-based-versioning`: use new diff-based versioning (default: false) (**requires**: `new-spec-version` to be set if `diff-based-versioning` is true)

- `new-spec-version`: the new spec version (only required when using diff-based-versioning)

- `use-minor-base`: create a new version file per each minor version (only used with diff-based-versioning) (default: `false`)

> NOTE: third party autocomplete repos must be structured as the official autocomplete one. Run `npx @withfig/autocomplete-tools@latest init` to generate one.