feat: add gitlab CI support

Author: dgellow

.gitlab-ci.yml

@@ -0,0 +1,15 @@
+image: node:20-alpine
+
+.upload-spec:
+  script:
+    - yarn install
+    - node dist/index.js
+  variables:
+    STAINLESS_API_KEY: $STAINLESS_API_KEY
+    INPUT_PATH: $INPUT_PATH
+    CONFIG_PATH: $CONFIG_PATH
+    OUTPUT_PATH: $OUTPUT_PATH
+    PROJECT_NAME: $PROJECT_NAME
+    COMMIT_MESSAGE: $COMMIT_MESSAGE
+    GUESS_CONFIG: $GUESS_CONFIG
+    BRANCH: $BRANCH

README.md

@@ -1,4 +1,4 @@
-# GitHub Action: upload your OpenAPI spec to Stainless
+# Upload your OpenAPI spec to Stainless (GitHub Action & GitLab CI)
 
 ```
 stainless-api/upload-openapi-spec
@@ -7,7 +7,7 @@ stainless-api/upload-openapi-spec
 [![lint](https://github.com/stainless-api/upload-openapi-spec-action/actions/workflows/lint.yml/badge.svg)](https://github.com/stainless-api/upload-openapi-spec-action/actions/workflows/lint.yml)
 [![build](https://github.com/stainless-api/upload-openapi-spec-action/actions/workflows/build.yml/badge.svg)](https://github.com/stainless-apiupload-openapi-spec-action/actions/workflows/build.yml)
 
-A GitHub Action for pushing your OpenAPI spec to [Stainless](https://stainless.com/) to trigger regeneration of your SDKs.
+A CI component for pushing your OpenAPI spec to [Stainless](https://stainless.com/) to trigger regeneration of your SDKs. Supports both GitHub Actions and GitLab CI.
 
 Note that there is currently a manual step in between this action and automatic creation of your PR's,
 and more manual steps before they are merged and released.
@@ -18,7 +18,11 @@ so that your API reference documentation can show examples of making each reques
 
 ## Example usage
 
-First, obtain an API Key from your Stainless dashboard, and [add it to your GitHub Actions secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) as `STAINLESS_API_KEY`:
+First, obtain an API Key from your Stainless dashboard.
+
+### GitHub Actions
+
+For GitHub Actions, [add the API key to your repository secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) as `STAINLESS_API_KEY`:
 
 ```
 gh secret set STAINLESS_API_KEY
@@ -50,6 +54,28 @@ jobs:
 
 You can optionally add `config_path: 'path/to/my-company.stainless.yaml'` to the `with:` block if you'd like to send us updates to your Stainless config.
 
+### GitLab CI
+
+For GitLab CI, add the API key to your [GitLab CI/CD variables](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project) as `STAINLESS_API_KEY`.
+
+Then, add the following to your `.gitlab-ci.yml` file:
+
+```yaml
+include:
+  - remote: 'https://raw.githubusercontent.com/stainless-api/upload-openapi-spec-action/main/.gitlab-ci.yml'
+
+upload-openapi-spec:
+  extends: .upload-spec
+  variables:
+    INPUT_PATH: 'path/to/my-company-openapi.json'
+    PROJECT_NAME: 'my-stainless-project'
+    COMMIT_MESSAGE: 'feat(api): my cool feature'
+    GUESS_CONFIG: 'true'
+    # CONFIG_PATH: 'path/to/my-company.stainless.yaml' # Optional
+    # OUTPUT_PATH: 'path/to/output.json' # Optional
+    # BRANCH: 'main' # Optional
+```
+
 You can identify your Stainless project name on the [Stainless dashboard](https://app.stainless.com/).
 
 ### Optional parameters
@@ -75,7 +101,9 @@ openapi:
   code_samples: readme
 ```
 
-Then configure your GitHub Action to upload the Stainless-enhanced OpenAPI spec to ReadMe:
+### GitHub Actions with ReadMe
+
+Configure your GitHub Action to upload the Stainless-enhanced OpenAPI spec to ReadMe:
 
 ```yaml
 name: Upload OpenAPI spec to Stainless and ReadMe
@@ -111,6 +139,46 @@ This assumes the following secrets have been [uploaded to your GitHub Actions Se
 
 Remember to set the `readmeio/rdme` ref version to the latest stable available (`v8`, as of this writing). You can verify the latest version of ReadMe's GitHub Action [here](https://github.com/marketplace/actions/rdme-sync-to-readme).
 
+### GitLab CI with ReadMe
+
+Configure your GitLab CI pipeline to upload the Stainless-enhanced OpenAPI spec to ReadMe:
+
+```yaml
+include:
+  - remote: 'https://raw.githubusercontent.com/stainless-api/upload-openapi-spec-action/main/.gitlab-ci.yml'
+
+stages:
+  - upload
+  - sync
+
+upload-openapi-spec:
+  stage: upload
+  extends: .upload-spec
+  variables:
+    INPUT_PATH: 'path/to/my-company-openapi.json'
+    OUTPUT_PATH: 'path/to/my-company-openapi.documented.json'
+    PROJECT_NAME: 'my-stainless-project'
+    COMMIT_MESSAGE: 'feat(api): my cool feature'
+  artifacts:
+    paths:
+      - path/to/my-company-openapi.documented.json
+
+sync-to-readme:
+  stage: sync
+  image: node:20-alpine
+  script:
+    - npm install -g rdme
+    - rdme openapi path/to/my-company-openapi.documented.json --key=$README_TOKEN --id=$README_DEFINITION_ID
+  dependencies:
+    - upload-openapi-spec
+```
+
+This assumes the following variables have been added to your GitLab CI/CD Variables:
+
+- `STAINLESS_API_KEY`: Your Stainless API key.
+- `README_TOKEN`: Your ReadMe API key.
+- `README_DEFINITION_ID`: Your ReadMe API definition ID.
+
 ## Usage with Mintlify for docs with example snippets
 
 If you use Mintlify's OpenAPI support for your API reference documentation,
@@ -121,7 +189,11 @@ openapi:
   code_samples: mintlify
 ```
 
-Mintlify can generate your docs based on the OpenAPI spec in your docs repo if it is [configured to do so](https://mintlify.com/docs/api-playground/openapi/setup#in-the-repo). To integrate Stainless, you can modify the GitHub Action that uploads your OpenAPI spec to Stainless such that it then pushes the Stainless-enhanced OpenAPI spec into your docs repo:
+Mintlify can generate your docs based on the OpenAPI spec in your docs repo if it is [configured to do so](https://mintlify.com/docs/api-playground/openapi/setup#in-the-repo).
+
+### GitHub Actions with Mintlify
+
+To integrate Stainless with your GitHub Actions workflow:
 
 ```yaml
 name: Upload OpenAPI spec to Stainless and (Mintlify) docs repo
@@ -161,3 +233,56 @@ This assumes the following secrets have been [uploaded to your GitHub Actions Se
 
 - `secrets.STAINLESS_API_KEY`: Your Stainless API key.
 - `secrets.API_TOKEN_GITHUB`: A GitHub [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with permissions to push to your docs repo.
+
+### GitLab CI with Mintlify
+
+To integrate Stainless with your GitLab CI pipeline:
+
+```yaml
+include:
+  - remote: 'https://raw.githubusercontent.com/stainless-api/upload-openapi-spec-action/main/.gitlab-ci.yml'
+
+stages:
+  - upload
+  - push-docs
+
+upload-openapi-spec:
+  stage: upload
+  extends: .upload-spec
+  variables:
+    INPUT_PATH: 'path/to/my-company-openapi.json'
+    OUTPUT_PATH: 'path/to/my-company-openapi.documented.json'
+    PROJECT_NAME: 'my-stainless-project'
+    COMMIT_MESSAGE: 'feat(api): my cool feature'
+  artifacts:
+    paths:
+      - path/to/my-company-openapi.documented.json
+
+push-to-docs-repo:
+  stage: push-docs
+  image: alpine:latest
+  script:
+    - apk add --no-cache git openssh
+    - mkdir -p ~/.ssh
+    - echo "$SSH_PRIVATE_KEY" | tr -d '\r' > ~/.ssh/id_rsa
+    - chmod 600 ~/.ssh/id_rsa
+    - ssh-keyscan gitlab.com >> ~/.ssh/known_hosts
+    - git config --global user.email "$GIT_USER_EMAIL"
+    - git config --global user.name "$GIT_USER_NAME"
+    - git clone git@gitlab.com:your-organization/docs-repo.git
+    - mkdir -p docs-repo/openapi-specs
+    - cp path/to/my-company-openapi.documented.json docs-repo/openapi-specs/
+    - cd docs-repo
+    - git add openapi-specs/my-company-openapi.documented.json
+    - git commit -m "Auto-updates from Stainless"
+    - git push origin main
+  dependencies:
+    - upload-openapi-spec
+```
+
+This assumes the following variables have been added to your GitLab CI/CD Variables:
+
+- `STAINLESS_API_KEY`: Your Stainless API key.
+- `SSH_PRIVATE_KEY`: An SSH private key with permissions to push to your docs repo.
+- `GIT_USER_EMAIL`: The email to use for the Git commits.
+- `GIT_USER_NAME`: The username to use for the Git commits.

action.yml

@@ -1,5 +1,5 @@
 name: Stainless — Upload OpenAPI specification
-description: Upload your OpenAPI spec to update your Stainless SDKs (and, if configured, add example snippets to your API docs)
+description: Upload your OpenAPI spec to update your Stainless SDKs (and, if configured, add example snippets to your API docs). Works with GitHub Actions and GitLab CI.
 branding:
   icon: book-open
   color: green