Merge pull request #1 from CASParser/release-please--branches--main--changes--next--components--cas-parser

sameerkumar18 · web-flow · commit cc26078bf671 · 2025-08-18T11:29:21.000+05:30
release: 1.0.0
diff --git a/.github/workflows/publish-npm.yml 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/CASParser/cas-parser-node/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@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: |
+          yarn install
+
+      - name: Publish to NPM
+        run: |
+          bash ./bin/publish-npm
+        env:
+          NPM_TOKEN: ${{ secrets.CAS_PARSER_NPM_TOKEN || secrets.NPM_TOKEN }}
diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml
@@ -0,0 +1,21 @@
+name: Release Doctor
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  release_doctor:
+    name: release doctor
+    runs-on: ubuntu-latest
+    if: github.repository == 'CASParser/cas-parser-node' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check release environment
+        run: |
+          bash ./bin/check-release-environment
+        env:
+          NPM_TOKEN: ${{ secrets.CAS_PARSER_NPM_TOKEN || secrets.NPM_TOKEN }}
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -0,0 +1,3 @@
+{
+  ".": "1.0.0"
+}
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 5
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cas-parser%2Fcas-parser-33841d833a48438cd79a13b2e70eeb61551b67e954ed788209ece1b0f5886e15.yml
 openapi_spec_hash: 6a784691ea7c8cf7c2987c93f6a2ab25
-config_hash: e038b1acdad8015d8d29b65c78c345fa
+config_hash: c35d87a285c3e03721211e5585e57e54
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,24 @@
+# Changelog
+
+## 1.0.0 (2025-08-18)
+
+Full Changelog: [v0.0.1-alpha.0...v1.0.0](https://github.com/CASParser/cas-parser-node/compare/v0.0.1-alpha.0...v1.0.0)
+
+### Features
+
+* **api:** manual updates ([1e6c39a](https://github.com/CASParser/cas-parser-node/commit/1e6c39a1be39d9bdb89d50f43c26f178a4f24b39))
+* **api:** manual updates ([676d6a3](https://github.com/CASParser/cas-parser-node/commit/676d6a33df8f48f3c72d7589251b8e4616e3e866))
+* **api:** manual updates ([76afa40](https://github.com/CASParser/cas-parser-node/commit/76afa403b2222d928d99c5eb3a9229e03e0c1de2))
+* **api:** manual updates ([4b9ce92](https://github.com/CASParser/cas-parser-node/commit/4b9ce92d3d6adef435618d31f67679c1cd564a6e))
+* **api:** manual updates ([a4c7c4f](https://github.com/CASParser/cas-parser-node/commit/a4c7c4f49bedad0d5f27c4a30845a343985d1702))
+
+
+### Chores
+
+* add docs to RequestOptions type ([bcdc5af](https://github.com/CASParser/cas-parser-node/commit/bcdc5af6492012646f690cd6e632790411db96eb))
+* **client:** improve path param validation ([d9e2f49](https://github.com/CASParser/cas-parser-node/commit/d9e2f4987c13a4e6e56757ccfc8c4f8105f84ff1))
+* **internal:** remove redundant imports config ([245bd3d](https://github.com/CASParser/cas-parser-node/commit/245bd3d586a4058218c56e915b29285e11abf795))
+* make some internal functions async ([cc8085d](https://github.com/CASParser/cas-parser-node/commit/cc8085d9c43e0ba0c3ff249518e2a3f890da15d0))
+* **ts:** reorder package.json imports ([7bd9452](https://github.com/CASParser/cas-parser-node/commit/7bd94525624bb8a8720b43b28bc7a073e60a653b))
+* update SDK settings ([d81dccb](https://github.com/CASParser/cas-parser-node/commit/d81dccbdc37c2440374d9e05f5a4d80bc1b16622))
+* update SDK settings ([a2f5d4c](https://github.com/CASParser/cas-parser-node/commit/a2f5d4cda1960a8ce0d3c41f8e6d40ec66829aee))
diff --git 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:
 
 ```sh
-$ npm install git+ssh://git@github.com:stainless-sdks/cas-parser-typescript.git
+$ npm install git+ssh://git@github.com:CASParser/cas-parser-node.git
 ```
 
 Alternatively, to link a local copy of the repo:
 
 ```sh
 # Clone
-$ git clone https://www.github.com/stainless-sdks/cas-parser-typescript
-$ cd cas-parser-typescript
+$ git clone https://www.github.com/CASParser/cas-parser-node
+$ cd cas-parser-node
 
 # With yarn
 $ yarn link
@@ -91,3 +91,17 @@ To format and fix all lint issues automatically:
 ```sh
 $ yarn fix
 ```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish with a GitHub workflow
+
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/CASParser/cas-parser-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
+the environment.
diff --git a/README.md b/README.md
@@ -11,12 +11,9 @@ It is generated with [Stainless](https://www.stainless.com/).
 ## Installation
 
 ```sh
-npm install git+ssh://git@github.com:stainless-sdks/cas-parser-typescript.git
+npm install cas-parser
 ```
 
-> [!NOTE]
-> Once this package is [published to npm](https://www.stainless.com/docs/guides/publish), this will become: `npm install cas-parser`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
@@ -366,7 +363,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/cas-parser-typescript/issues) with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/CASParser/cas-parser-node/issues) with questions, bugs, or suggestions.
 
 ## Requirements
 
diff --git a/bin/check-release-environment b/bin/check-release-environment
@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+errors=()
+
+if [ -z "${NPM_TOKEN}" ]; then
+  errors+=("The NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
+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
@@ -1,12 +1,12 @@
 {
   "name": "cas-parser",
-  "version": "0.0.1-alpha.0",
+  "version": "1.0.0",
   "description": "The official TypeScript library for the Cas Parser API",
   "author": "Cas Parser <sameer@casparser.in>",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "type": "commonjs",
-  "repository": "github:stainless-sdks/cas-parser-typescript",
+  "repository": "github:CASParser/cas-parser-node",
   "license": "Apache-2.0",
   "packageManager": "yarn@1.22.22",
   "files": [
diff --git a/release-please-config.json b/release-please-config.json
@@ -0,0 +1,64 @@
+{
+  "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/version.ts b/src/version.ts
@@ -1 +1 @@
-export const VERSION = '0.0.1-alpha.0';
+export const VERSION = '1.0.0'; // x-release-please-version
