Skip to content

Commit

Permalink
Rename jsDoc workflow to tsDoc and update configurations
Browse files Browse the repository at this point in the history
The jsDoc.yml file has been renamed to tsDoc.yml. The workflow configuration has been updated to focus on releases from the master branch only. Recursion is no longer enabled, and the TypeDoc Action is now used instead of jsDoc. Furthermore, configurations for output path, source directory, and front page have been adjusted.
  • Loading branch information
erikyo committed Dec 12, 2023
1 parent 0999c8a commit 49c5deb
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions .github/workflows/jsDoc.yml → .github/workflows/tsDoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ name: JSDoc Action
on:
release:
branches: [ "master" ]
pull_request:
types: [ closed ]
branches:
- master
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

Expand All @@ -33,14 +29,12 @@ jobs:
- name: Checkout code
uses: actions/checkout@v3

- name: Build Docs
uses: andstor/jsdoc-action@v1
- name: TypeDoc Action
uses: erikyo/tsdoc-action@v1
with:
source_dir: ./lib
recurse: true
source_dir: ./src/*
output_dir: ./docs
config_file: jsdoc.json
front_page: readme.md
front_page: README.md

- name: Setup Pages
uses: actions/configure-pages@v3
Expand Down

0 comments on commit 49c5deb

Please sign in to comment.