mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
ci: fix docs workflow on v14 tag push (#11438)
This commit is contained in:
121
.github/workflows/documentation.yml
vendored
121
.github/workflows/documentation.yml
vendored
@@ -1,8 +1,6 @@
|
|||||||
name: Documentation
|
name: Documentation
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
|
||||||
- 'main'
|
|
||||||
paths:
|
paths:
|
||||||
- 'packages/*/src/**'
|
- 'packages/*/src/**'
|
||||||
- '!packages/create-discord-bot/**'
|
- '!packages/create-discord-bot/**'
|
||||||
@@ -13,14 +11,7 @@ on:
|
|||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
ref:
|
ref:
|
||||||
description: 'The branch, tag or SHA to checkout'
|
description: 'The tag to checkout'
|
||||||
required: true
|
|
||||||
ref_type:
|
|
||||||
type: choice
|
|
||||||
description: 'Branch or tag'
|
|
||||||
options:
|
|
||||||
- branch
|
|
||||||
- tag
|
|
||||||
required: true
|
required: true
|
||||||
concurrency:
|
concurrency:
|
||||||
group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
|
group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
|
||||||
@@ -32,7 +23,6 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
|
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
|
||||||
TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
|
TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
|
||||||
REF_TYPE: ${{ inputs.ref_type || github.ref_type }}
|
|
||||||
if: github.repository_owner == 'discordjs'
|
if: github.repository_owner == 'discordjs'
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
@@ -52,13 +42,11 @@ jobs:
|
|||||||
run: pnpm run build
|
run: pnpm run build
|
||||||
|
|
||||||
- name: Checkout main repository
|
- name: Checkout main repository
|
||||||
if: ${{ inputs.ref && inputs.ref != 'main' }}
|
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
path: 'main'
|
path: 'main'
|
||||||
|
|
||||||
- name: Build main
|
- name: Build main
|
||||||
if: ${{ inputs.ref && inputs.ref != 'main' }}
|
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
cd main
|
cd main
|
||||||
@@ -67,26 +55,20 @@ jobs:
|
|||||||
cd ..
|
cd ..
|
||||||
|
|
||||||
- name: Extract package and semver from tag
|
- name: Extract package and semver from tag
|
||||||
if: ${{ env.REF_TYPE == 'tag' }}
|
|
||||||
id: extract-tag
|
id: extract-tag
|
||||||
uses: ./packages/actions/src/formatTag
|
uses: ./packages/actions/src/formatTag
|
||||||
with:
|
with:
|
||||||
tag: ${{ inputs.ref || github.ref_name }}
|
tag: ${{ inputs.ref || github.ref_name }}
|
||||||
|
|
||||||
- name: Apply tag to api-extractor config
|
|
||||||
if: ${{ env.REF_TYPE == 'tag' && !inputs.ref }}
|
|
||||||
run: sed -i 's!https://github.com/discordjs/discord.js/tree/main!https://github.com/discordjs/discord.js/tree/${{ github.ref_name }}!' "packages/${{ steps.extract-tag.outputs.package}}/api-extractor.json"
|
|
||||||
|
|
||||||
- name: Build docs
|
- name: Build docs
|
||||||
run: pnpm run docs
|
run: pnpm run docs
|
||||||
|
|
||||||
- name: Build docs with main api-extractor
|
- name: Build docs with main api-extractor
|
||||||
if: ${{ inputs.ref && inputs.ref != 'main' }}
|
|
||||||
run: |
|
run: |
|
||||||
declare -a PACKAGES=("brokers" "builders" "collection" "core" "discord.js" "formatters" "next" "proxy" "rest" "util" "voice" "ws")
|
declare -a PACKAGES=("brokers" "builders" "collection" "core" "discord.js" "formatters" "next" "proxy" "rest" "util" "voice" "ws")
|
||||||
for PACKAGE in "${PACKAGES[@]}"; do
|
for PACKAGE in "${PACKAGES[@]}"; do
|
||||||
cd "packages/${PACKAGE}"
|
cd "packages/${PACKAGE}"
|
||||||
sed -i 's!https://github.com/discordjs/discord.js/tree/main!https://github.com/discordjs/discord.js/tree/${{ inputs.ref }}!' api-extractor.json
|
sed -i 's!https://github.com/discordjs/discord.js/tree/main!https://github.com/discordjs/discord.js/tree/${{ inputs.ref || github.ref_name }}!' api-extractor.json
|
||||||
../../main/packages/api-extractor/bin/api-extractor run --local --minify
|
../../main/packages/api-extractor/bin/api-extractor run --local --minify
|
||||||
../../main/packages/scripts/bin/generateSplitDocumentation.js
|
../../main/packages/scripts/bin/generateSplitDocumentation.js
|
||||||
cd ../..
|
cd ../..
|
||||||
@@ -100,25 +82,6 @@ jobs:
|
|||||||
path: 'out'
|
path: 'out'
|
||||||
|
|
||||||
- name: Upload documentation to database
|
- name: Upload documentation to database
|
||||||
if: ${{ env.REF_TYPE == 'tag' && (!inputs.ref || inputs.ref == 'main') }}
|
|
||||||
env:
|
|
||||||
DATABASE_URL: ${{ secrets.DATABASE_URL }}
|
|
||||||
CF_D1_DOCS_API_KEY: ${{ secrets.CF_D1_DOCS_API_KEY }}
|
|
||||||
CF_D1_DOCS_ID: ${{ secrets.CF_D1_DOCS_ID }}
|
|
||||||
CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
|
|
||||||
BLOB_READ_WRITE_TOKEN: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
|
|
||||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
|
||||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
|
||||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
|
||||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
|
||||||
CF_R2_DOCS_BUCKET_URL: ${{ secrets.CF_R2_DOCS_BUCKET_URL }}
|
|
||||||
uses: ./packages/actions/src/uploadDocumentation
|
|
||||||
with:
|
|
||||||
package: ${{ steps.extract-tag.outputs.package }}
|
|
||||||
version: ${{ steps.extract-tag.outputs.semver }}
|
|
||||||
|
|
||||||
- name: Upload documentation to database
|
|
||||||
if: ${{ env.REF_TYPE == 'tag' && inputs.ref && inputs.ref != 'main' }}
|
|
||||||
env:
|
env:
|
||||||
DATABASE_URL: ${{ secrets.DATABASE_URL }}
|
DATABASE_URL: ${{ secrets.DATABASE_URL }}
|
||||||
CF_D1_DOCS_API_KEY: ${{ secrets.CF_D1_DOCS_API_KEY }}
|
CF_D1_DOCS_API_KEY: ${{ secrets.CF_D1_DOCS_API_KEY }}
|
||||||
@@ -136,20 +99,6 @@ jobs:
|
|||||||
version: ${{ steps.extract-tag.outputs.semver }}
|
version: ${{ steps.extract-tag.outputs.semver }}
|
||||||
|
|
||||||
- name: Upload split documentation to blob storage
|
- name: Upload split documentation to blob storage
|
||||||
if: ${{ env.REF_TYPE == 'tag' && (!inputs.ref || inputs.ref == 'main') }}
|
|
||||||
env:
|
|
||||||
BLOB_READ_WRITE_TOKEN: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
|
|
||||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
|
||||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
|
||||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
|
||||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
|
||||||
uses: ./packages/actions/src/uploadSplitDocumentation
|
|
||||||
with:
|
|
||||||
package: ${{ steps.extract-tag.outputs.package }}
|
|
||||||
version: ${{ steps.extract-tag.outputs.semver }}
|
|
||||||
|
|
||||||
- name: Upload split documentation to blob storage
|
|
||||||
if: ${{ env.REF_TYPE == 'tag' && inputs.ref && inputs.ref != 'main' }}
|
|
||||||
env:
|
env:
|
||||||
BLOB_READ_WRITE_TOKEN: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
|
BLOB_READ_WRITE_TOKEN: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
|
||||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
||||||
@@ -162,7 +111,6 @@ jobs:
|
|||||||
version: ${{ steps.extract-tag.outputs.semver }}
|
version: ${{ steps.extract-tag.outputs.semver }}
|
||||||
|
|
||||||
- name: Move docs to correct directory
|
- name: Move docs to correct directory
|
||||||
if: ${{ env.REF_TYPE == 'tag' }}
|
|
||||||
env:
|
env:
|
||||||
PACKAGE: ${{ steps.extract-tag.outputs.package }}
|
PACKAGE: ${{ steps.extract-tag.outputs.package }}
|
||||||
SEMVER: ${{ steps.extract-tag.outputs.semver }}
|
SEMVER: ${{ steps.extract-tag.outputs.semver }}
|
||||||
@@ -175,71 +123,6 @@ jobs:
|
|||||||
mv "packages/${PACKAGE}/docs/docs.api.json" "out/${PACKAGE}/${SEMVER}.api.json"
|
mv "packages/${PACKAGE}/docs/docs.api.json" "out/${PACKAGE}/${SEMVER}.api.json"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- name: Upload documentation to database
|
|
||||||
if: ${{ env.REF_TYPE == 'branch' && (!inputs.ref || inputs.ref == 'main') }}
|
|
||||||
env:
|
|
||||||
DATABASE_URL: ${{ secrets.DATABASE_URL }}
|
|
||||||
CF_D1_DOCS_API_KEY: ${{ secrets.CF_D1_DOCS_API_KEY }}
|
|
||||||
CF_D1_DOCS_ID: ${{ secrets.CF_D1_DOCS_ID }}
|
|
||||||
CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
|
|
||||||
BLOB_READ_WRITE_TOKEN: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
|
|
||||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
|
||||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
|
||||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
|
||||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
|
||||||
CF_R2_DOCS_BUCKET_URL: ${{ secrets.CF_R2_DOCS_BUCKET_URL }}
|
|
||||||
uses: ./packages/actions/src/uploadDocumentation
|
|
||||||
|
|
||||||
- name: Upload documentation to database
|
|
||||||
if: ${{ env.REF_TYPE == 'branch' && inputs.ref && inputs.ref != 'main' }}
|
|
||||||
env:
|
|
||||||
DATABASE_URL: ${{ secrets.DATABASE_URL }}
|
|
||||||
CF_D1_DOCS_API_KEY: ${{ secrets.CF_D1_DOCS_API_KEY }}
|
|
||||||
CF_D1_DOCS_ID: ${{ secrets.CF_D1_DOCS_ID }}
|
|
||||||
CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
|
|
||||||
BLOB_READ_WRITE_TOKEN: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
|
|
||||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
|
||||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
|
||||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
|
||||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
|
||||||
CF_R2_DOCS_BUCKET_URL: ${{ secrets.CF_R2_DOCS_BUCKET_URL }}
|
|
||||||
uses: ./main/packages/actions/src/uploadDocumentation
|
|
||||||
|
|
||||||
- name: Upload split documentation to blob storage
|
|
||||||
if: ${{ env.REF_TYPE == 'branch' && (!inputs.ref || inputs.ref == 'main') }}
|
|
||||||
env:
|
|
||||||
BLOB_READ_WRITE_TOKEN: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
|
|
||||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
|
||||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
|
||||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
|
||||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
|
||||||
uses: ./packages/actions/src/uploadSplitDocumentation
|
|
||||||
|
|
||||||
- name: Upload split documentation to blob storage
|
|
||||||
if: ${{ env.REF_TYPE == 'branch' && inputs.ref && inputs.ref != 'main' }}
|
|
||||||
env:
|
|
||||||
BLOB_READ_WRITE_TOKEN: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
|
|
||||||
CF_R2_DOCS_URL: ${{ secrets.CF_R2_DOCS_URL }}
|
|
||||||
CF_R2_DOCS_ACCESS_KEY_ID: ${{ secrets.CF_R2_DOCS_ACCESS_KEY_ID }}
|
|
||||||
CF_R2_DOCS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_DOCS_SECRET_ACCESS_KEY }}
|
|
||||||
CF_R2_DOCS_BUCKET: ${{ secrets.CF_R2_DOCS_BUCKET }}
|
|
||||||
uses: ./main/packages/actions/src/uploadSplitDocumentation
|
|
||||||
|
|
||||||
- name: Move docs to correct directory
|
|
||||||
if: ${{ env.REF_TYPE == 'branch' }}
|
|
||||||
run: |
|
|
||||||
declare -a PACKAGES=("brokers" "builders" "collection" "core" "discord.js" "formatters" "next" "proxy" "rest" "util" "voice" "ws")
|
|
||||||
for PACKAGE in "${PACKAGES[@]}"; do
|
|
||||||
if [[ "${PACKAGE}" == "discord.js" ]]; then
|
|
||||||
mkdir -p "out/${PACKAGE}"
|
|
||||||
mv "packages/${PACKAGE}/docs/docs.json" "out/${PACKAGE}/${GITHUB_REF_NAME}.json"
|
|
||||||
mv "packages/${PACKAGE}/docs/docs.api.json" "out/${PACKAGE}/${GITHUB_REF_NAME}.api.json"
|
|
||||||
else
|
|
||||||
mkdir -p "out/${PACKAGE}"
|
|
||||||
mv "packages/${PACKAGE}/docs/docs.api.json" "out/${PACKAGE}/${GITHUB_REF_NAME}.api.json"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
- name: Commit and push
|
- name: Commit and push
|
||||||
run: |
|
run: |
|
||||||
cd out
|
cd out
|
||||||
|
|||||||
Reference in New Issue
Block a user