chore: added and improved TSDoc of pricing module (#5335)

* adjusted tsdoc of methods and types in pricing module

* finished adding tsdocs

* small fixes

* remove reference files

* added github action

* fix typo in outPath

* Update packages/types/src/shared-context.ts

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>

* fix sharedContext description

* changed branch name of action

* added ignore for is_dynamic

* added private remark

---------

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
This commit is contained in:
Shahed Nasser
2023-10-10 13:23:54 +03:00
committed by GitHub
parent 4ebcd3af6a
commit 57bd38bb4b
22 changed files with 2774 additions and 232 deletions

View File

@@ -192,4 +192,49 @@ jobs:
labels: "type: chore"
add-paths: www/apps/docs/content/references/js-client/**
branch: "docs/generate-js-client"
branch-suffix: "timestamp"
pricing:
runs-on: ubuntu-latest
steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.11.0
with:
access_token: ${{ github.token }}
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Node.js environment
uses: actions/setup-node@v3
with:
node-version: "16.20.2"
cache: "yarn"
- name: Install dependencies
uses: ./.github/actions/cache-deps
with:
extension: reference
- name: Build Packages
run: yarn build
- name: Install Workspace dependencies
run: yarn install
working-directory: docs-utils
- name: Generate Pricing Module Reference
run: yarn generate:references pricing
working-directory: docs-utils/packages/scripts
- name: Create Pull Request
uses: peter-evans/create-pull-request@v4
with:
commit-message: "chore(docs): Generated Pricing Module Reference (automated)"
base: "develop"
title: "chore(docs): Generated Pricing Module Reference"
labels: "type: chore"
add-paths: www/apps/docs/content/references/pricing/**
branch: "docs/generate-pricing"
branch-suffix: "timestamp"