diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 86f853f..7d303fd 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -2,10 +2,10 @@ name: CI on: push: branches: - - main + - stainless pull_request: branches: - - main + - stainless jobs: lint: diff --git a/.github/workflows/publish-npm.yml b/.github/workflows/publish-npm.yml new file mode 100644 index 0000000..0a466a9 --- /dev/null +++ b/.github/workflows/publish-npm.yml @@ -0,0 +1,32 @@ +# This workflow is triggered when a GitHub release is created. +# It can also be run manually to re-publish to NPM in case it failed for some reason. +# You can run this workflow by navigating to https://www.github.com/vvonchain/case-filing-api/actions/workflows/publish-npm.yml +name: Publish NPM +on: + workflow_dispatch: + + release: + types: [published] + +jobs: + publish: + name: publish + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Set up Node + uses: actions/setup-node@v3 + with: + node-version: '18' + + - name: Install dependencies + run: | + yarn install + + - name: Publish to NPM + run: | + bash ./bin/publish-npm + env: + NPM_TOKEN: ${{ secrets.CASE_FILING_API_NPM_TOKEN || secrets.NPM_TOKEN }} diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml new file mode 100644 index 0000000..24c66f0 --- /dev/null +++ b/.github/workflows/release-doctor.yml @@ -0,0 +1,19 @@ +name: Release Doctor +on: + pull_request: + workflow_dispatch: + +jobs: + release_doctor: + name: release doctor + runs-on: ubuntu-latest + if: github.repository == 'vvonchain/case-filing-api' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') + + steps: + - uses: actions/checkout@v3 + + - name: Check release environment + run: | + bash ./bin/check-release-environment + env: + NPM_TOKEN: ${{ secrets.CASE_FILING_API_NPM_TOKEN || secrets.NPM_TOKEN }} diff --git a/.release-please-manifest.json b/.release-please-manifest.json new file mode 100644 index 0000000..063a4ae --- /dev/null +++ b/.release-please-manifest.json @@ -0,0 +1,3 @@ +{ + ".": "0.0.1-alpha.1" +} diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1d69f50 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +## 0.0.1-alpha.1 (2024-04-24) + +Full Changelog: [v0.0.1-alpha.0...v0.0.1-alpha.1](https://github.com/vvonchain/case-filing-api/compare/v0.0.1-alpha.0...v0.0.1-alpha.1) + +### Chores + +* go live ([#3](https://github.com/vvonchain/case-filing-api/issues/3)) ([1d0c275](https://github.com/vvonchain/case-filing-api/commit/1d0c275534769394b20b1365277f9f8176bd379f)) +* update SDK settings ([#1](https://github.com/vvonchain/case-filing-api/issues/1)) ([8db6408](https://github.com/vvonchain/case-filing-api/commit/8db6408c456baf0ee45bbb0f6e3c6a57172f2d90)) +* update SDK settings ([#10](https://github.com/vvonchain/case-filing-api/issues/10)) ([c3ba917](https://github.com/vvonchain/case-filing-api/commit/c3ba917b8f8baa56ad4c7bdee4090f434bc8b956)) +* update SDK settings ([#5](https://github.com/vvonchain/case-filing-api/issues/5)) ([45e4bfc](https://github.com/vvonchain/case-filing-api/commit/45e4bfcb9826e711281ef97a07ba95a7dc9755c3)) +* update SDK settings ([#6](https://github.com/vvonchain/case-filing-api/issues/6)) ([e93e7de](https://github.com/vvonchain/case-filing-api/commit/e93e7de1176773ed0f449479944dfab967cdfbeb)) +* update SDK settings ([#7](https://github.com/vvonchain/case-filing-api/issues/7)) ([15fafaa](https://github.com/vvonchain/case-filing-api/commit/15fafaa228a7583b03f0b2163f3435228e9d583b)) +* update SDK settings ([#8](https://github.com/vvonchain/case-filing-api/issues/8)) ([72de202](https://github.com/vvonchain/case-filing-api/commit/72de202133f5716d7e4e7ef8ec1416dbddc725c4)) +* update SDK settings ([#9](https://github.com/vvonchain/case-filing-api/issues/9)) ([64ca1b2](https://github.com/vvonchain/case-filing-api/commit/64ca1b2d48a2cb59ab9291a60d39562ae6993161)) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 627ae8a..f9108ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,15 +42,15 @@ If you’d like to use the repository from source, you can either install from g To install via git: ```bash -npm install git+ssh://git@github.com:stainless-sdks/kubera-studio/case-filing-api-node.git +npm install git+ssh://git@github.com:vvonchain/case-filing-api.git ``` Alternatively, to link a local copy of the repo: ```bash # Clone -git clone https://www.github.com/stainless-sdks/kubera-studio/case-filing-api-node -cd case-filing-api-node +git clone https://www.github.com/vvonchain/case-filing-api +cd case-filing-api # With yarn yarn link @@ -99,7 +99,7 @@ the changes aren't made through the automated pipeline, you may want to make rel ### Publish with a GitHub workflow -You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/stainless-sdks/kubera-studio/case-filing-api-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up. +You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/vvonchain/case-filing-api/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up. ### Publish manually diff --git a/README.md b/README.md index 16f5afe..faca5a6 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,9 @@ It is generated with [Stainless](https://www.stainlessapi.com/). ## Installation ```sh -npm install git+ssh://git@github.com:stainless-sdks/kubera-studio/case-filing-api-node.git +npm install case-filing-api ``` -> [!NOTE] -> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install case-filing-api` - ## Usage The full API of this library can be found in [api.md](api.md). @@ -214,7 +211,7 @@ import CaseFilingAPI from 'case-filing-api'; ``` To do the inverse, add `import "case-filing-api/shims/node"` (which does import polyfills). -This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/stainless-sdks/tree/main/src/_shims#readme)). +This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/vvonchain/case-filing-api/tree/stainless/src/_shims#readme)). ### Logging and middleware @@ -271,7 +268,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience. -We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/kubera-studio/case-filing-api-node/issues) with questions, bugs, or suggestions. +We are keen for your feedback; please open an [issue](https://www.github.com/vvonchain/case-filing-api/issues) with questions, bugs, or suggestions. ## Requirements diff --git a/bin/check-release-environment b/bin/check-release-environment new file mode 100644 index 0000000..4827d40 --- /dev/null +++ b/bin/check-release-environment @@ -0,0 +1,32 @@ +#!/usr/bin/env bash + +warnings=() +errors=() + +if [ -z "${NPM_TOKEN}" ]; then + warnings+=("The CASE_FILING_API_NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets") +fi + +lenWarnings=${#warnings[@]} + +if [[ lenWarnings -gt 0 ]]; then + echo -e "Found the following warnings in the release environment:\n" + + for warning in "${warnings[@]}"; do + echo -e "- $warning\n" + done +fi + +lenErrors=${#errors[@]} + +if [[ lenErrors -gt 0 ]]; then + echo -e "Found the following errors in the release environment:\n" + + for error in "${errors[@]}"; do + echo -e "- $error\n" + done + + exit 1 +fi + +echo "The environment is ready to push releases!" diff --git a/package.json b/package.json index ec5d4ce..65fb425 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,12 @@ { "name": "case-filing-api", - "version": "0.0.1-alpha.0", + "version": "0.0.1-alpha.1", "description": "The official TypeScript library for the Case Filing API API", "author": "Case Filing API ", "types": "dist/index.d.ts", "main": "dist/index.js", "type": "commonjs", - "repository": "github:stainless-sdks/case-filing-api-node", + "repository": "github:vvonchain/case-filing-api", "license": "Apache-2.0", "packageManager": "yarn@1.22.22", "files": [ diff --git a/release-please-config.json b/release-please-config.json new file mode 100644 index 0000000..624ed99 --- /dev/null +++ b/release-please-config.json @@ -0,0 +1,67 @@ +{ + "packages": { + ".": {} + }, + "$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json", + "include-v-in-tag": true, + "include-component-in-tag": false, + "versioning": "prerelease", + "prerelease": true, + "bump-minor-pre-major": true, + "bump-patch-for-minor-pre-major": false, + "pull-request-header": "Automated Release PR", + "pull-request-title-pattern": "release: ${version}", + "changelog-sections": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "perf", + "section": "Performance Improvements" + }, + { + "type": "revert", + "section": "Reverts" + }, + { + "type": "chore", + "section": "Chores" + }, + { + "type": "docs", + "section": "Documentation" + }, + { + "type": "style", + "section": "Styles" + }, + { + "type": "refactor", + "section": "Refactors" + }, + { + "type": "test", + "section": "Tests", + "hidden": true + }, + { + "type": "build", + "section": "Build System" + }, + { + "type": "ci", + "section": "Continuous Integration", + "hidden": true + } + ], + "release-type": "node", + "extra-files": [ + "src/version.ts", + "README.md" + ] +} diff --git a/src/_shims/index-deno.ts b/src/_shims/index-deno.ts index 07233c0..40a1454 100644 --- a/src/_shims/index-deno.ts +++ b/src/_shims/index-deno.ts @@ -79,7 +79,7 @@ export function getDefaultAgent(url: string) { } export function fileFromPath() { throw new Error( - 'The `fileFromPath` function is only supported in Node. See the README for more details: https://www.github.com/stainless-sdks/kubera-studio/case-filing-api-node#file-uploads', + 'The `fileFromPath` function is only supported in Node. See the README for more details: https://www.github.com/vvonchain/case-filing-api#file-uploads', ); } diff --git a/src/_shims/web-runtime.ts b/src/_shims/web-runtime.ts index 9d7a21c..20e95a5 100644 --- a/src/_shims/web-runtime.ts +++ b/src/_shims/web-runtime.ts @@ -95,7 +95,7 @@ export function getRuntime({ manuallyImported }: { manuallyImported?: boolean } getDefaultAgent: (url: string) => undefined, fileFromPath: () => { throw new Error( - 'The `fileFromPath` function is only supported in Node. See the README for more details: https://www.github.com/stainless-sdks/kubera-studio/case-filing-api-node#file-uploads', + 'The `fileFromPath` function is only supported in Node. See the README for more details: https://www.github.com/vvonchain/case-filing-api#file-uploads', ); }, isFsReadStream: (value: any) => false, diff --git a/src/version.ts b/src/version.ts index 55a1a52..2c77b51 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '0.0.1-alpha.0'; +export const VERSION = '0.0.1-alpha.1'; // x-release-please-version