docs: update Typedoc and regenerate references (#1994)

* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions

View File

@@ -0,0 +1,53 @@
name: Generate JS Client Reference
on:
push:
branches:
- "master"
paths:
- packages/medusa-js/src/resources/**
pull_request:
types:
- closed
branches:
- "master"
paths:
- packages/medusa-js/src/resources/**
jobs:
services:
runs-on: ubuntu-latest
steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.9.1
with:
access_token: ${{ github.token }}
- name: Checkout
uses: actions/checkout@v2.3.5
with:
fetch-depth: 0
- name: Setup Node.js environment
uses: actions/setup-node@v2.4.1
with:
node-version: "14"
cache: "yarn"
- name: Install dependencies
uses: ./.github/actions/cache-deps
with:
extension: reference
- name: Build Packages
run: yarn build
- name: Generate Services Reference
run: yarn generate:services
- name: Create Pull Request
uses: peter-evans/create-pull-request@v4
with:
commit-message: 'docs: Generated JS Client Reference (automated)'
base: 'master'
title: 'docs: Generated JS Client Reference (automated)'
labels: 'type: docs'
add-paths: docs/content/references/js-client/**

View File

@@ -1,5 +1,10 @@
name: Generate References
name: Generate Reference
on:
push:
branches:
- "master"
paths:
- packages/medusa/src/services/**
pull_request:
types:
- closed
@@ -19,7 +24,6 @@ jobs:
- name: Checkout
uses: actions/checkout@v2.3.5
with:
token: ${{ secrets.REFERENCE_PAT }}
fetch-depth: 0
- name: Setup Node.js environment
@@ -39,9 +43,11 @@ jobs:
- name: Generate Services Reference
run: yarn generate:services
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: "docs: automatically Generated Services Reference"
file_pattern: docs/content/*
skip_dirty_check: false
branch: master
- name: Create Pull Request
uses: peter-evans/create-pull-request@v4
with:
commit-message: 'docs: Generated Services Reference (automated)'
base: 'master'
title: 'docs: Generated Services Reference (automated)'
labels: 'type: docs'
add-paths: docs/content/references/services/**