diff --git a/.changeset/giant-sloths-begin.md b/.changeset/giant-sloths-begin.md new file mode 100644 index 0000000..2728108 --- /dev/null +++ b/.changeset/giant-sloths-begin.md @@ -0,0 +1,6 @@ +--- +"@api-client-sdk-streamline-sample/products-api": patch +"@api-client-sdk-streamline-sample/users-api": patch +--- + +Update api description diff --git a/.github/workflows/version-packages.yml b/.github/workflows/version-packages.yml new file mode 100644 index 0000000..b684708 --- /dev/null +++ b/.github/workflows/version-packages.yml @@ -0,0 +1,48 @@ +name: Version Packages + +on: + push: + branches: + - main + workflow_dispatch: + +concurrency: ${{ github.workflow }}-${{ github.ref }} + +jobs: + version: + name: Create Version PR + runs-on: ubuntu-latest + steps: + - name: Checkout Repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: 20 + cache: 'npm' + + - name: Install Dependencies + run: npm ci + + - name: Create Version PR + id: changesets + uses: changesets/action@v1 + with: + version: npm run version-packages + title: "chore: update package versions" + commit: "chore: update package versions" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Print Version Status + run: | + if [[ "${{ steps.changesets.outputs.published }}" == "true" ]]; then + echo "✨ Version updates created" + echo "Updated packages: ${{ steps.changesets.outputs.publishedPackages }}" + else + echo "No version updates needed or PR created" + fi + \ No newline at end of file diff --git a/apps/products-api/src/config/swagger.config.ts b/apps/products-api/src/config/swagger.config.ts index 742e2ce..861c924 100644 --- a/apps/products-api/src/config/swagger.config.ts +++ b/apps/products-api/src/config/swagger.config.ts @@ -5,7 +5,7 @@ import { version } from '../../package.json'; export const swaggerConfig = new DocumentBuilder() .setTitle('@api-client-sdk-streamline-sample | Products API') .setDescription( - 'Sample Products API for API client SDK workflow demonstration. Part of [api-client-sdk-streamline-sample](https://github.com/junjie-w/api-client-sdk-streamline-sample) project.', + 'Sample Products API for streamlined API client SDK workflow demonstration.\nPart of [api-client-sdk-streamline-sample](https://github.com/junjie-w/api-client-sdk-streamline-sample) project.', ) .setVersion(version) .build(); diff --git a/apps/users-api/src/config/swagger.config.ts b/apps/users-api/src/config/swagger.config.ts index bfce1a7..dc4dd90 100644 --- a/apps/users-api/src/config/swagger.config.ts +++ b/apps/users-api/src/config/swagger.config.ts @@ -4,7 +4,7 @@ import { version } from '../../package.json'; export const swaggerConfig = new DocumentBuilder() .setTitle('@api-client-sdk-streamline-sample | Users API') .setDescription( - 'Sample Users API for API client SDK workflow demonstration. Part of [api-client-sdk-streamline-sample](https://github.com/junjie-w/api-client-sdk-streamline-sample) project.', + 'Sample Users API for streamlined API client SDK workflow demonstration.\nPart of [api-client-sdk-streamline-sample](https://github.com/junjie-w/api-client-sdk-streamline-sample) project.', ) .setVersion(version) .build();