docs-util: add docblock generator for models built with DML (#8296)

* docs-util: add docblock generator for models built with DML

* add missing turbo task
This commit is contained in:
Shahed Nasser
2024-07-29 11:11:39 +03:00
committed by GitHub
parent cb33ec5cf1
commit d127abbcda
30 changed files with 749 additions and 63 deletions

View File

@@ -116,3 +116,55 @@ jobs:
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: 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/**

View File

@@ -64,4 +64,56 @@ jobs:
www/apps/api-reference/specs
www/utils/generated/oas-output
branch: "docs/generate-api-ref"
branch-suffix: "timestamp"
branch-suffix: "timestamp"
preview-dml:
name: Generate DML JSON files
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: 20
cache: "yarn"
- name: Install dependencies
uses: ./.github/actions/cache-deps
with:
extension: reference
- name: Build Packages
run: yarn build
- name: Install www/utils Dependencies
run: yarn
working-directory: www/utils
- name: Build www/utils packages
run: yarn build
working-directory: www/utils
- name: Run docblock generator
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
uses: peter-evans/create-pull-request@v4
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/**