chore(docs): Updated API Reference (v2) (#9666) #2335
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Generate Docblocks [Automated] | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| workflow_dispatch: | |
| jobs: | |
| generate: | |
| name: Generated TSDoc PRs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v3 | |
| - name: Setup Node.js 20 | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 20 | |
| - name: Install Dependencies | |
| run: yarn | |
| - name: Build Dependencies | |
| run: yarn build | |
| - name: Install www/utils Dependencies | |
| run: yarn | |
| working-directory: www/utils | |
| - name: Build packages | |
| run: yarn build | |
| working-directory: www/utils | |
| - name: Check Commit | |
| id: check-commit | |
| run: "yarn check:release-commit ${{ github.sha }}" | |
| working-directory: www/utils/packages/scripts | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GIT_OWNER: ${{ github.repository_owner }} | |
| GIT_REPO: medusa | |
| - name: Run docblock generator | |
| if: steps.check-commit.outputs.is_release_commit == 'true' | |
| run: "yarn start run:release --type docs" | |
| working-directory: www/utils/packages/docs-generator | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GIT_OWNER: ${{ github.repository_owner }} | |
| GIT_REPO: medusa | |
| - name: Generate Changeset | |
| if: steps.check-commit.outputs.is_release_commit == 'true' | |
| run: "yarn generate:changeset" | |
| working-directory: www/utils/packages/scripts | |
| - name: Create Pull Request | |
| if: steps.check-commit.outputs.is_release_commit == 'true' | |
| uses: peter-evans/create-pull-request@v5 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| title: "chore(docs): Generated TSDocs" | |
| body: "This PR holds all generated TSDocs for the upcoming release." | |
| branch: "chore/generate-tsdocs" | |
| branch-suffix: "timestamp" | |
| add-paths: packages/** | |
| generate-oas: | |
| name: Generated OAS PR | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v3 | |
| - name: Setup Node.js 20 | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 20 | |
| - name: Install Dependencies | |
| run: yarn | |
| - name: Build Dependencies | |
| run: yarn build | |
| - name: Install www/utils Dependencies | |
| run: yarn | |
| working-directory: www/utils | |
| - name: Build packages | |
| run: yarn build | |
| working-directory: www/utils | |
| - name: Check Commit | |
| id: check-commit | |
| run: "yarn check:release-commit ${{ github.sha }}" | |
| working-directory: www/utils/packages/scripts | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GIT_OWNER: ${{ github.repository_owner }} | |
| GIT_REPO: medusa | |
| - name: Run docblock generator | |
| if: steps.check-commit.outputs.is_release_commit == 'true' | |
| run: "yarn generate:oas" | |
| working-directory: www/utils | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GIT_OWNER: ${{ github.repository_owner }} | |
| GIT_REPO: medusa | |
| - name: Create Pull Request | |
| if: steps.check-commit.outputs.is_release_commit == 'true' | |
| uses: peter-evans/create-pull-request@v5 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| title: "chore(docs): Generated OAS" | |
| body: "This PR holds all generated OAS for the upcoming release." | |
| branch: "chore/generate-oas" | |
| branch-suffix: "timestamp" | |
| add-paths: www/utils/generated/oas-output/** | |
| generate-dml: | |
| name: Generated DML JSON files PR | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v3 | |
| - name: Setup Node.js 20 | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 20 | |
| - name: Install Dependencies | |
| run: yarn | |
| - name: Build Dependencies | |
| run: yarn build | |
| - name: Install www/utils Dependencies | |
| run: yarn | |
| working-directory: www/utils | |
| - name: Build packages | |
| run: yarn build | |
| working-directory: www/utils | |
| - name: Check Commit | |
| id: check-commit | |
| run: "yarn check:release-commit ${{ github.sha }}" | |
| working-directory: www/utils/packages/scripts | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GIT_OWNER: ${{ github.repository_owner }} | |
| GIT_REPO: medusa | |
| - name: Run docblock generator | |
| if: steps.check-commit.outputs.is_release_commit == 'true' | |
| run: "yarn generate:dml" | |
| working-directory: www/utils | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GIT_OWNER: ${{ github.repository_owner }} | |
| GIT_REPO: medusa | |
| - name: Create Pull Request | |
| if: steps.check-commit.outputs.is_release_commit == 'true' | |
| uses: peter-evans/create-pull-request@v5 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| title: "chore(docs): Generated DML JSON files" | |
| body: "This PR holds all generated DML JSON files for the upcoming release." | |
| branch: "chore/generate-dml-json" | |
| branch-suffix: "timestamp" | |
| add-paths: www/utils/generated/dml-output/** |