From c8d7822ff760551a29404dd1d886dd5f7da5d040 Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Sun, 2 Feb 2025 15:23:34 -0600 Subject: [PATCH] chore(internal): improve CI/CD naming (#5821) --- .github/workflows/ci.yml | 4 +-- ...create-cli-release.yml => cli-release.yml} | 4 +-- .../{fern.yml => definitions-validation.yml} | 5 ++-- .github/workflows/dependabot.yml | 2 +- .github/workflows/fhir.yml | 27 ------------------- .github/workflows/go-generator.yml | 2 +- .../{ir-publish.yml => ir-release.yml} | 2 +- .../{ir-check.yml => ir-validation.yml} | 4 +-- .github/workflows/java-generator.yml | 2 +- .../{lint-pr.yml => lint-pr-title.yml} | 4 ++- ...ir-check.yml => openapi-ir-validation.yml} | 6 ++--- .github/workflows/preview-docs.yml | 13 +++++---- .github/workflows/publish-cli.yml | 8 +++--- ...ition.yml => publish-docs-parsers-sdk.yml} | 2 +- .github/workflows/publish-docs.yml | 6 +---- .../publish-generator-csharp-model.yml | 6 ++--- .../publish-generator-csharp-sdk.yml | 6 ++--- .../workflows/publish-generator-go-fiber.yml | 6 ++--- .../workflows/publish-generator-go-model.yml | 6 ++--- .../workflows/publish-generator-go-sdk.yml | 6 ++--- .../publish-generator-java-model.yml | 6 ++--- .../workflows/publish-generator-java-sdk.yml | 6 ++--- .../publish-generator-java-spring.yml | 6 ++--- .../workflows/publish-generator-openapi.yml | 6 ++--- .../workflows/publish-generator-php-model.yml | 6 ++--- .../workflows/publish-generator-php-sdk.yml | 6 ++--- .../workflows/publish-generator-postman.yml | 6 ++--- ...l => publish-generator-python-fastapi.yml} | 6 ++--- ... => publish-generator-python-pydantic.yml} | 6 ++--- .../publish-generator-python-sdk.yml | 6 ++--- .../publish-generator-ruby-model.yml | 6 ++--- .../workflows/publish-generator-ruby-sdk.yml | 6 ++--- .../publish-generator-ts-express.yml | 6 ++--- .github/workflows/publish-generator.yml | 2 +- .../workflows/publish-go-dynamic-snippets.yml | 2 +- ...{python-sdk.yml => publish-python-sdk.yml} | 6 ++--- .github/workflows/publish-snippets-core.yml | 2 +- .../workflows/publish-ts-dynamic-snippets.yml | 2 +- ...ode-sdk.yml => publish-typescript-sdk.yml} | 13 ++++----- .github/workflows/python-generator.yml | 2 +- .github/workflows/seed-dockers.yml | 2 +- .github/workflows/seed.yml | 4 +-- .github/workflows/setup-seed.yml | 26 ------------------ .github/workflows/vale.yml | 2 +- .github/workflows/version-check.yml | 2 +- .../sdks/publish-sdk/publish-your-sdk.mdx | 4 +-- 46 files changed, 104 insertions(+), 164 deletions(-) rename .github/workflows/{create-cli-release.yml => cli-release.yml} (97%) rename .github/workflows/{fern.yml => definitions-validation.yml} (94%) delete mode 100644 .github/workflows/fhir.yml rename .github/workflows/{ir-publish.yml => ir-release.yml} (99%) rename .github/workflows/{ir-check.yml => ir-validation.yml} (96%) rename .github/workflows/{lint-pr.yml => lint-pr-title.yml} (93%) rename .github/workflows/{openapi-ir-check.yml => openapi-ir-validation.yml} (92%) rename .github/workflows/{publish-docs-parsers-fern-definition.yml => publish-docs-parsers-sdk.yml} (94%) rename .github/workflows/{publish-generator-fastapi.yml => publish-generator-python-fastapi.yml} (96%) rename .github/workflows/{publish-generator-pydantic.yml => publish-generator-python-pydantic.yml} (96%) rename .github/workflows/{python-sdk.yml => publish-python-sdk.yml} (76%) rename .github/workflows/{node-sdk.yml => publish-typescript-sdk.yml} (64%) delete mode 100644 .github/workflows/setup-seed.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 14facfff22b..19051056731 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ -name: ci +name: CI on: push: @@ -177,7 +177,7 @@ jobs: outputs: typescript: ${{ steps.filter.outputs.typescript }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: dorny/paths-filter@v2 id: filter with: diff --git a/.github/workflows/create-cli-release.yml b/.github/workflows/cli-release.yml similarity index 97% rename from .github/workflows/create-cli-release.yml rename to .github/workflows/cli-release.yml index b33194c0df3..b0fe47c2c98 100644 --- a/.github/workflows/create-cli-release.yml +++ b/.github/workflows/cli-release.yml @@ -16,14 +16,14 @@ env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} jobs: - release-cli: + run: if: github.repository == 'fern-api/fern' runs-on: ubuntu-latest outputs: version: ${{ steps.get_version.outputs.VERSION }} steps: - name: Checkout code - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: ref: main fetch-depth: 2 diff --git a/.github/workflows/fern.yml b/.github/workflows/definitions-validation.yml similarity index 94% rename from .github/workflows/fern.yml rename to .github/workflows/definitions-validation.yml index b90f4b62a5f..1b3c70709b9 100644 --- a/.github/workflows/fern.yml +++ b/.github/workflows/definitions-validation.yml @@ -1,4 +1,4 @@ -name: fern +name: Validate Fern Definitions on: pull_request: @@ -8,7 +8,7 @@ on: - main jobs: - check-definitions: + run: runs-on: ubuntu-latest steps: - name: Checkout repo @@ -28,4 +28,3 @@ jobs: pnpm --filter @fern-api/cli dist:cli:prod cli_path="$(pwd)/packages/cli/cli/dist/prod/cli.cjs" node $cli_path check - diff --git a/.github/workflows/dependabot.yml b/.github/workflows/dependabot.yml index ecd1d30f738..bcb0269254d 100644 --- a/.github/workflows/dependabot.yml +++ b/.github/workflows/dependabot.yml @@ -1,4 +1,4 @@ -name: dependabot +name: Dependabot on: pull_request: diff --git a/.github/workflows/fhir.yml b/.github/workflows/fhir.yml deleted file mode 100644 index 4dbda27eeb7..00000000000 --- a/.github/workflows/fhir.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: fhir -on: - push: - branches: main - paths: - - "fern/apis/fhir/**" - -jobs: - register: - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Setup Node.js - uses: actions/setup-node@v4 - with: - node-version: "18" - - - name: Install Fern - run: npm install -g fern-api - - - name: Register fhir definition - env: - FERN_TOKEN: ${{ secrets.FERN_TOKEN }} - run: | - fern register --api fhir diff --git a/.github/workflows/go-generator.yml b/.github/workflows/go-generator.yml index a95a38c6121..ea290455421 100644 --- a/.github/workflows/go-generator.yml +++ b/.github/workflows/go-generator.yml @@ -1,4 +1,4 @@ -name: go +name: Go Generator on: pull_request: diff --git a/.github/workflows/ir-publish.yml b/.github/workflows/ir-release.yml similarity index 99% rename from .github/workflows/ir-publish.yml rename to .github/workflows/ir-release.yml index df12a9d7ce4..d2ca77e6b3f 100644 --- a/.github/workflows/ir-publish.yml +++ b/.github/workflows/ir-release.yml @@ -1,4 +1,4 @@ -name: IR SDKs +name: Release IR SDKs on: workflow_dispatch: diff --git a/.github/workflows/ir-check.yml b/.github/workflows/ir-validation.yml similarity index 96% rename from .github/workflows/ir-check.yml rename to .github/workflows/ir-validation.yml index 9bcf13a90c7..0472ac7a95a 100644 --- a/.github/workflows/ir-check.yml +++ b/.github/workflows/ir-validation.yml @@ -1,4 +1,4 @@ -name: IR Check +name: IR Validation on: workflow_dispatch: @@ -14,7 +14,7 @@ on: - main jobs: - check: + run: runs-on: ubuntu-latest steps: - name: Checkout repository diff --git a/.github/workflows/java-generator.yml b/.github/workflows/java-generator.yml index 5132695fded..228ba376e34 100644 --- a/.github/workflows/java-generator.yml +++ b/.github/workflows/java-generator.yml @@ -1,4 +1,4 @@ -name: java +name: Java Generator on: pull_request: diff --git a/.github/workflows/lint-pr.yml b/.github/workflows/lint-pr-title.yml similarity index 93% rename from .github/workflows/lint-pr.yml rename to .github/workflows/lint-pr-title.yml index 87dd96a1cb8..80f19724bbc 100644 --- a/.github/workflows/lint-pr.yml +++ b/.github/workflows/lint-pr-title.yml @@ -1,4 +1,4 @@ -name: "Lint PR Title" +name: Lint PR Title on: pull_request_target: @@ -44,6 +44,8 @@ jobs: openapi deps deps-dev + fiber + pydantic requireScope: true env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/openapi-ir-check.yml b/.github/workflows/openapi-ir-validation.yml similarity index 92% rename from .github/workflows/openapi-ir-check.yml rename to .github/workflows/openapi-ir-validation.yml index 52457bed148..1c64d2253e3 100644 --- a/.github/workflows/openapi-ir-check.yml +++ b/.github/workflows/openapi-ir-validation.yml @@ -1,4 +1,4 @@ -name: OpenAPI IR Check +name: Validate OpenAPI IR on: workflow_dispatch: @@ -14,7 +14,7 @@ on: - main jobs: - check: + run: runs-on: ubuntu-latest steps: - name: Checkout repository @@ -23,7 +23,7 @@ jobs: - name: Install uses: ./.github/actions/install - - name: Install Fern + - name: Install Fern CLI run: npm install -g fern-api - name: Check IR Definitions diff --git a/.github/workflows/preview-docs.yml b/.github/workflows/preview-docs.yml index 0eec322e08a..a301404009f 100644 --- a/.github/workflows/preview-docs.yml +++ b/.github/workflows/preview-docs.yml @@ -1,12 +1,12 @@ -name: preview-docs +name: Preview Docs on: pull_request_target: branches: - main - paths: - - 'fern/**' - - 'packages/cli/docs-**' + paths: + - "fern/**" + - "packages/cli/docs-**" workflow_dispatch: inputs: prNumber: @@ -18,8 +18,8 @@ jobs: run: runs-on: ubuntu-latest permissions: - pull-requests: write # Only for commenting - contents: read # For checking out code + pull-requests: write # Only for commenting + contents: read # For checking out code steps: - name: Checkout repository uses: actions/checkout@v4 @@ -67,4 +67,3 @@ jobs: -X PATCH \ -f "body"="🌿 Preview your docs: [$PREVIEW_URL]($PREVIEW_URL)" fi - diff --git a/.github/workflows/publish-cli.yml b/.github/workflows/publish-cli.yml index 506c01fb214..038795fccdf 100644 --- a/.github/workflows/publish-cli.yml +++ b/.github/workflows/publish-cli.yml @@ -1,4 +1,4 @@ -name: Publish Dev + Prod CLIs +name: Publish Fern CLI on: push: @@ -12,7 +12,7 @@ on: type: string jobs: - publish-dev: + dev: if: ${{ inputs.version == null && github.repository == 'fern-api/fern' }} runs-on: ubuntu-latest env: @@ -69,7 +69,7 @@ jobs: cli_path="$(pwd)/packages/cli/cli/dist/prod/cli.cjs" ./scripts/live-test.sh "$cli_path" "$FERN_TOKEN" - publish: + prod: needs: [live-test] if: ${{ inputs.version == null }} runs-on: ubuntu-latest @@ -110,7 +110,7 @@ jobs: pnpm seed publish cli --changelog packages/cli/cli/versions.yml --previous-changelog tmp_cli_previous_versions.yml --log-level debug pnpm seed register cli - publish-manually: + manual: runs-on: ubuntu-latest if: ${{ inputs.version != null }} env: diff --git a/.github/workflows/publish-docs-parsers-fern-definition.yml b/.github/workflows/publish-docs-parsers-sdk.yml similarity index 94% rename from .github/workflows/publish-docs-parsers-fern-definition.yml rename to .github/workflows/publish-docs-parsers-sdk.yml index e86f9ddba9a..ed4d43be955 100644 --- a/.github/workflows/publish-docs-parsers-fern-definition.yml +++ b/.github/workflows/publish-docs-parsers-sdk.yml @@ -1,4 +1,4 @@ -name: publish-docs-parsers-fern-definition +name: Publish @fern-fern/docs-parsers-fern-definition on: workflow_dispatch: diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 839b0df18ed..97ce839c00d 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -1,7 +1,6 @@ -name: publish-docs +name: Publish Docs on: - workflow_dispatch: # Added manual trigger push: paths: - "fern/**" @@ -17,9 +16,6 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 - - name: Checkout repo - uses: actions/checkout@v4 - - name: Install uses: ./.github/actions/install diff --git a/.github/workflows/publish-generator-csharp-model.yml b/.github/workflows/publish-generator-csharp-model.yml index 57c0bef3bd1..460c0aa3990 100644 --- a/.github/workflows/publish-generator-csharp-model.yml +++ b/.github/workflows/publish-generator-csharp-model.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-csharp-model +name: Publish C# Model Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-csharp-sdk.yml b/.github/workflows/publish-generator-csharp-sdk.yml index d51c9eb4493..3fc868efb1c 100644 --- a/.github/workflows/publish-generator-csharp-sdk.yml +++ b/.github/workflows/publish-generator-csharp-sdk.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-csharp-sdk +name: Publish C# SDK Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-go-fiber.yml b/.github/workflows/publish-generator-go-fiber.yml index d8f7023d68d..a2b47ee5c9d 100644 --- a/.github/workflows/publish-generator-go-fiber.yml +++ b/.github/workflows/publish-generator-go-fiber.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-go-fiber +name: Publish Go Fiber Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-go-model.yml b/.github/workflows/publish-generator-go-model.yml index 93d914a2caa..f67b69076ee 100644 --- a/.github/workflows/publish-generator-go-model.yml +++ b/.github/workflows/publish-generator-go-model.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-go-model +name: Publish Go Model Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-go-sdk.yml b/.github/workflows/publish-generator-go-sdk.yml index 0039f4d0d9c..2a089fba3ca 100644 --- a/.github/workflows/publish-generator-go-sdk.yml +++ b/.github/workflows/publish-generator-go-sdk.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-go-sdk +name: Publish Go SDK Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-java-model.yml b/.github/workflows/publish-generator-java-model.yml index 9551cb50e8d..371e74623a8 100644 --- a/.github/workflows/publish-generator-java-model.yml +++ b/.github/workflows/publish-generator-java-model.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-java-model +name: Publish Java Model Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-java-sdk.yml b/.github/workflows/publish-generator-java-sdk.yml index b4b35a40d66..20e72239889 100644 --- a/.github/workflows/publish-generator-java-sdk.yml +++ b/.github/workflows/publish-generator-java-sdk.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-java-sdk +name: Publish Java SDK Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-java-spring.yml b/.github/workflows/publish-generator-java-spring.yml index 85fc68c33b7..6e9dcedca39 100644 --- a/.github/workflows/publish-generator-java-spring.yml +++ b/.github/workflows/publish-generator-java-spring.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-java-spring +name: Publish Java Spring Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-openapi.yml b/.github/workflows/publish-generator-openapi.yml index 8414cc865ce..494cf93edc1 100644 --- a/.github/workflows/publish-generator-openapi.yml +++ b/.github/workflows/publish-generator-openapi.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-openapi +name: Publish OpenAPI Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-php-model.yml b/.github/workflows/publish-generator-php-model.yml index b912af35377..84d017bf1dc 100644 --- a/.github/workflows/publish-generator-php-model.yml +++ b/.github/workflows/publish-generator-php-model.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-php-model +name: Publish PHP Model Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-php-sdk.yml b/.github/workflows/publish-generator-php-sdk.yml index aa2b209594b..c8735d70cce 100644 --- a/.github/workflows/publish-generator-php-sdk.yml +++ b/.github/workflows/publish-generator-php-sdk.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-php-sdk +name: Publish PHP SDK Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-postman.yml b/.github/workflows/publish-generator-postman.yml index 739268b56e6..e84d9de5ed5 100644 --- a/.github/workflows/publish-generator-postman.yml +++ b/.github/workflows/publish-generator-postman.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-postman +name: Publish Postman Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-fastapi.yml b/.github/workflows/publish-generator-python-fastapi.yml similarity index 96% rename from .github/workflows/publish-generator-fastapi.yml rename to .github/workflows/publish-generator-python-fastapi.yml index 4b50ff06c3e..d3ff6eeeb10 100644 --- a/.github/workflows/publish-generator-fastapi.yml +++ b/.github/workflows/publish-generator-python-fastapi.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-fastapi +name: Publish Python FastAPI Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-pydantic.yml b/.github/workflows/publish-generator-python-pydantic.yml similarity index 96% rename from .github/workflows/publish-generator-pydantic.yml rename to .github/workflows/publish-generator-python-pydantic.yml index 812edc0fe85..5e420e148c2 100644 --- a/.github/workflows/publish-generator-pydantic.yml +++ b/.github/workflows/publish-generator-python-pydantic.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-pydantic +name: Publish Pydantic Model Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-python-sdk.yml b/.github/workflows/publish-generator-python-sdk.yml index fda3a7ee643..974dfc2c039 100644 --- a/.github/workflows/publish-generator-python-sdk.yml +++ b/.github/workflows/publish-generator-python-sdk.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-python-sdk +name: Publish Python SDK Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-ruby-model.yml b/.github/workflows/publish-generator-ruby-model.yml index 3b9ba4ae633..d4954a543c5 100644 --- a/.github/workflows/publish-generator-ruby-model.yml +++ b/.github/workflows/publish-generator-ruby-model.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-ruby-model +name: Publish Ruby Model Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-ruby-sdk.yml b/.github/workflows/publish-generator-ruby-sdk.yml index 94333d2a4bb..a1aa5175697 100644 --- a/.github/workflows/publish-generator-ruby-sdk.yml +++ b/.github/workflows/publish-generator-ruby-sdk.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-ruby-sdk +name: Publish Ruby SDK Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -53,7 +53,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator-ts-express.yml b/.github/workflows/publish-generator-ts-express.yml index 6cff32e6912..a77c3b36ad8 100644 --- a/.github/workflows/publish-generator-ts-express.yml +++ b/.github/workflows/publish-generator-ts-express.yml @@ -1,5 +1,5 @@ # Generators are registered within seed.yml, once their tests are passing -name: publish-and-register-ts-express +name: Publish TypeScript Express Generator on: push: @@ -18,7 +18,7 @@ env: DOCKER_BUILDKIT: 1 jobs: - publish-changed-generators: + run: if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest steps: @@ -59,7 +59,7 @@ jobs: # Manually publish and register generators # The logic is identical to the step above, but could not find a good way to work with the matrix AND manual trigger in one job - publish-manually: + manual: runs-on: ubuntu-latest # Only run this job if this has been triggered manually if: ${{ github.event_name == 'workflow_dispatch' }} diff --git a/.github/workflows/publish-generator.yml b/.github/workflows/publish-generator.yml index aa5ab3b3611..3ca93ec8053 100644 --- a/.github/workflows/publish-generator.yml +++ b/.github/workflows/publish-generator.yml @@ -25,7 +25,7 @@ jobs: outputs: ts-sdk: ${{ steps.filter.outputs.ts-sdk }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: dorny/paths-filter@v2 id: filter with: diff --git a/.github/workflows/publish-go-dynamic-snippets.yml b/.github/workflows/publish-go-dynamic-snippets.yml index 733783ce93d..6bc7b5fc8c0 100644 --- a/.github/workflows/publish-go-dynamic-snippets.yml +++ b/.github/workflows/publish-go-dynamic-snippets.yml @@ -14,7 +14,7 @@ env: NPM_TOKEN: ${{ secrets.FERN_NPM_TOKEN }} jobs: - publish: + run: runs-on: ubuntu-latest if: ${{ inputs.version != null }} steps: diff --git a/.github/workflows/python-sdk.yml b/.github/workflows/publish-python-sdk.yml similarity index 76% rename from .github/workflows/python-sdk.yml rename to .github/workflows/publish-python-sdk.yml index 9f4e8e4607c..cdea5c59edd 100644 --- a/.github/workflows/python-sdk.yml +++ b/.github/workflows/publish-python-sdk.yml @@ -1,10 +1,10 @@ -name: python-sdk +name: Publish Python SDK on: workflow_dispatch: inputs: version: - description: "The version of the python SDK that you would like to release" + description: "The version of the Python SDK that you would like to release for Fern's public API" required: true type: string @@ -15,7 +15,7 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 - - name: Install Fern + - name: Install Fern CLI run: npm install -g fern-api - name: Release Python SDK diff --git a/.github/workflows/publish-snippets-core.yml b/.github/workflows/publish-snippets-core.yml index 3ce98dadb37..1e975003727 100644 --- a/.github/workflows/publish-snippets-core.yml +++ b/.github/workflows/publish-snippets-core.yml @@ -14,7 +14,7 @@ env: NPM_TOKEN: ${{ secrets.FERN_NPM_TOKEN }} jobs: - publish: + run: runs-on: ubuntu-latest if: ${{ inputs.version != null }} steps: diff --git a/.github/workflows/publish-ts-dynamic-snippets.yml b/.github/workflows/publish-ts-dynamic-snippets.yml index 09d3df0aa77..cfbafd39f36 100644 --- a/.github/workflows/publish-ts-dynamic-snippets.yml +++ b/.github/workflows/publish-ts-dynamic-snippets.yml @@ -14,7 +14,7 @@ env: NPM_TOKEN: ${{ secrets.FERN_NPM_TOKEN }} jobs: - publish: + run: runs-on: ubuntu-latest if: ${{ inputs.version != null }} steps: diff --git a/.github/workflows/node-sdk.yml b/.github/workflows/publish-typescript-sdk.yml similarity index 64% rename from .github/workflows/node-sdk.yml rename to .github/workflows/publish-typescript-sdk.yml index 76a74d828ad..9ee068ab295 100644 --- a/.github/workflows/node-sdk.yml +++ b/.github/workflows/publish-typescript-sdk.yml @@ -1,10 +1,10 @@ -name: node-sdk +name: Release TypeScript SDK on: workflow_dispatch: inputs: version: - description: "The version of the Node SDK that you would like to release" + description: "The version of the TypeScript SDK that you would like to release for Fern's public API" required: true type: string @@ -13,15 +13,12 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 - - name: Setup node - uses: actions/setup-node@v3 - - - name: Download Fern + - name: Install Fern CLI run: npm install -g fern-api - - name: Release Node SDK + - name: Release TypeScript SDK env: FERN_TOKEN: ${{ secrets.FERN_TOKEN }} NPM_TOKEN: ${{ secrets.FERN_NPM_TOKEN }} diff --git a/.github/workflows/python-generator.yml b/.github/workflows/python-generator.yml index 605ed9ea7cd..a02cd0cbc1b 100644 --- a/.github/workflows/python-generator.yml +++ b/.github/workflows/python-generator.yml @@ -1,4 +1,4 @@ -name: python +name: Python Generator on: pull_request: diff --git a/.github/workflows/seed-dockers.yml b/.github/workflows/seed-dockers.yml index bc5ba201bc8..cdb8cb25ce7 100644 --- a/.github/workflows/seed-dockers.yml +++ b/.github/workflows/seed-dockers.yml @@ -21,7 +21,7 @@ jobs: outputs: packages: ${{ steps.filter.outputs.changes }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: dorny/paths-filter@v2 id: filter with: diff --git a/.github/workflows/seed.yml b/.github/workflows/seed.yml index 6876dd89f3e..3138242f90f 100644 --- a/.github/workflows/seed.yml +++ b/.github/workflows/seed.yml @@ -1,4 +1,4 @@ -name: seed +name: Seed Snapshot Tests on: push: @@ -29,7 +29,7 @@ jobs: csharp: ${{ steps.filter.outputs.csharp }} php: ${{ steps.filter.outputs.php }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: dorny/paths-filter@v2 id: filter with: diff --git a/.github/workflows/setup-seed.yml b/.github/workflows/setup-seed.yml deleted file mode 100644 index c725b80ee92..00000000000 --- a/.github/workflows/setup-seed.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: Setup Seed - -on: workflow_call - -jobs: - setup: - runs-on: ubuntu-latest - steps: - - uses: actions/setup-node@v3 - with: - node-version: 18 - cache: "pnpm" - - - name: pnpm Install - run: pnpm install - - - uses: bufbuild/buf-setup-action@v1.34.0 - with: - github_token: ${{ github.token }} - - - uses: actions/setup-go@v5 - with: - go-version: 'stable' - - - name: Install protoc-gen-openapi - run: go install github.com/google/gnostic/cmd/protoc-gen-openapi@v0.7.0 diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index c54fb34af73..20493c391f3 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -9,7 +9,7 @@ jobs: name: runner / vale runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Retrieve changed files id: files diff --git a/.github/workflows/version-check.yml b/.github/workflows/version-check.yml index be8f1165ca5..230edf7e005 100644 --- a/.github/workflows/version-check.yml +++ b/.github/workflows/version-check.yml @@ -15,7 +15,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Install uses: ./.github/actions/install diff --git a/fern/pages/sdks/publish-sdk/publish-your-sdk.mdx b/fern/pages/sdks/publish-sdk/publish-your-sdk.mdx index 2626975b933..f3ad4dae9f8 100644 --- a/fern/pages/sdks/publish-sdk/publish-your-sdk.mdx +++ b/fern/pages/sdks/publish-sdk/publish-your-sdk.mdx @@ -235,7 +235,7 @@ This guide will walk you through how to publish public-facing SDKs through Fern. ```yaml title="Python" maxLines=0 - name: python-sdk + name: Publish Python SDK on: workflow_dispatch: @@ -263,7 +263,7 @@ This guide will walk you through how to publish public-facing SDKs through Fern. fern generate --group python-sdk --version ${{ inputs.version }} --log-level debug ``` ```yaml title="TypeScript" maxLines=0 - name: ts-sdk + name: Publish TypeScript SDK on: workflow_dispatch: