Skip to content

Commit

Permalink
add configuration file for jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
JeffreyDallas committed Mar 11, 2024
1 parent d7c3b47 commit 13d4dd3
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/flow-publish-jsdoc-github-pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
##
# Copyright (C) 2023-2024 Hedera Hashgraph, LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
##

name: GitHub pages

on:
push:
branches:
- 00119-jsdoc-support
pull_request:

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Build
uses: andstor/jsdoc-action@v1
with:
source_dir: ./src
output_dir: ./out
config_file: jsdoc.conf.json
template: minami
front_page: README.md

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/00119-jsdoc-support'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./out
5 changes: 5 additions & 0 deletions jsdoc.conf.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"source": {
"includePattern": ".+\\.(js(doc|x)?|mjs)$"
}
}

0 comments on commit 13d4dd3

Please sign in to comment.