Skip to content

[CI] Feature: Deploy typedoc to permalink #6

[CI] Feature: Deploy typedoc to permalink

[CI] Feature: Deploy typedoc to permalink #6

Workflow file for this run

name: TypeDoc
on:
pull_request:
types: [opened, edited, reopened, synchronize]
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
"Generate TypeDoc":

Check failure on line 18 in .github/workflows/typedoc.yml

View workflow run for this annotation

GitHub Actions / TypeDoc

Invalid workflow file

The workflow is not valid. .github/workflows/typedoc.yml (Line: 18, Col: 3): The identifier 'Generate TypeDoc' is invalid. IDs may only contain alphanumeric characters, '_', and '-'. IDs must start with a letter or '_' and and must be less than 100 characters. .github/workflows/typedoc.yml (Line: 38, Col: 3): The identifier 'Deploy TypeDoc' is invalid. IDs may only contain alphanumeric characters, '_', and '-'. IDs must start with a letter or '_' and and must be less than 100 characters.
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install
uses: ./.github/composite-actions/install
- name: Generate Documentation
run: pnpm typedoc
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './typedoc/documentation.json'
"Deploy TypeDoc":
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4