From 049010ae45206b4f4c51e95857523e562662b2ec Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 09:22:17 -0500 Subject: [PATCH 01/17] remove absolute path and matrix for node version --- .github/workflows/publish-docs.yml | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 395401ec1d..49846fa310 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -9,10 +9,6 @@ jobs: publish-docs: runs-on: ubuntu-latest - strategy: - matrix: - node_version: [18.x] - steps: - name: Checkout git repo uses: actions/checkout@v3 @@ -20,7 +16,7 @@ jobs: - name: Install Node and NPM uses: actions/setup-node@v3 with: - node-version: ${{ matrix.node_version }} + node-version: [18.x] cache: npm - name: Install and build @@ -30,10 +26,10 @@ jobs: - name: Build documentation run: | # renaming the folders so that pages links at /{their name} instead of at /docs - cd ~/lib/papi-components + cd lib/papi-components npm run build:docs mv docs papi-components - cd ~/lib/papi-dts + cd ../papi-dts npm run build:docs mv docs papi-dts From 675300fb4056bcd305795b37f166251320d68f02 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 09:26:30 -0500 Subject: [PATCH 02/17] add debug step to test --- .github/workflows/publish-docs.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 49846fa310..6b228559f5 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -24,6 +24,11 @@ jobs: npm install npm run build + - name: Debug + run: | + pwd + ls -la + - name: Build documentation run: | # renaming the folders so that pages links at /{their name} instead of at /docs cd lib/papi-components From a81e2e24b2d08d960e54cf356b83ea260c5e5cb7 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 09:29:13 -0500 Subject: [PATCH 03/17] add current branch as one to watch --- .github/workflows/publish-docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 6b228559f5..13c7761008 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -4,6 +4,7 @@ on: push: branches: - main + - fix-publish-docs jobs: publish-docs: From 6d9e1f6cf42a0babe3bf1149b2e0c81f68741139 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 09:35:10 -0500 Subject: [PATCH 04/17] fix error with node version --- .github/workflows/publish-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 13c7761008..36f91c4718 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -17,7 +17,7 @@ jobs: - name: Install Node and NPM uses: actions/setup-node@v3 with: - node-version: [18.x] + node-version: 18.x cache: npm - name: Install and build From 41697d36c4c8a25e90c7bc0d47814689ccc33ae6 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 10:04:03 -0500 Subject: [PATCH 05/17] skip renaming --- .github/workflows/publish-docs.yml | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 36f91c4718..d4f020f915 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -25,19 +25,12 @@ jobs: npm install npm run build - - name: Debug - run: | - pwd - ls -la - - name: Build documentation run: | # renaming the folders so that pages links at /{their name} instead of at /docs cd lib/papi-components - npm run build:docs - mv docs papi-components + npx typedoc --out papi-components cd ../papi-dts - npm run build:docs - mv docs papi-dts + npx typedoc --out papi-dts - name: Deploy to GitHub Pages uses: JamesIves/github-pages-deploy-action@4.1.4 From fd80f725159ebef17d5b175b90b39c6af36d9c70 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 10:36:26 -0500 Subject: [PATCH 06/17] test deploy path --- .github/workflows/publish-docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index d4f020f915..99d7044313 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -38,4 +38,3 @@ jobs: branch: github-pages folder: | lib/papi-components/papi-components - lib/papi-dts/papi-dts From 9386508a2af017cdcd22dcdfb66c1895f07d22ea Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 11:13:21 -0500 Subject: [PATCH 07/17] put docs into one folder --- .github/workflows/publish-docs.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 99d7044313..f100dc1e66 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -26,15 +26,18 @@ jobs: npm run build - name: Build documentation - run: | # renaming the folders so that pages links at /{their name} instead of at /docs + run: | # need to specify --out so pages links at /{their name} instead of at /docs cd lib/papi-components npx typedoc --out papi-components cd ../papi-dts npx typedoc --out papi-dts + cd ../../ + mkdir docs-for-pages + mv lib/papi-components/papi-components docs-for-pages + mv lib/papi-dts/papi-dts docs-for-pages - name: Deploy to GitHub Pages uses: JamesIves/github-pages-deploy-action@4.1.4 with: branch: github-pages - folder: | - lib/papi-components/papi-components + folder: docs-for-pages From 8396b4d1cadc7deccde1bfc644f75792963c1a7d Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 11:34:02 -0500 Subject: [PATCH 08/17] remove publish-docs branch --- .github/workflows/publish-docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index f100dc1e66..cf01878dff 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -4,7 +4,6 @@ on: push: branches: - main - - fix-publish-docs jobs: publish-docs: From ff4256e6f1a6294bc8b7ef6792c0fe3d3a384473 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 14:05:03 -0500 Subject: [PATCH 09/17] remove npx from build script, switch entry point for components --- lib/papi-components/package.json | 2 +- lib/papi-components/typedoc.json | 6 +++--- lib/papi-dts/package.json | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/papi-components/package.json b/lib/papi-components/package.json index dd622f99df..f6d1a50fb3 100644 --- a/lib/papi-components/package.json +++ b/lib/papi-components/package.json @@ -31,7 +31,7 @@ "scripts": { "start": "vite --host --open", "build:basic": "tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts", - "build:docs": "npx typedoc", + "build:docs": "typedoc", "build": "npm run build:basic && npm run lint-fix", "watch": "tsc && vite build --watch", "lint": "npm run lint:scripts && npm run lint:styles", diff --git a/lib/papi-components/typedoc.json b/lib/papi-components/typedoc.json index 8ca2afc577..b26e48dc74 100644 --- a/lib/papi-components/typedoc.json +++ b/lib/papi-components/typedoc.json @@ -1,7 +1,7 @@ { - "entryPoints": ["src"], - "entryPointStrategy": "expand", - "exclude": ["src/index.ts"], + "entryPoints": ["src/index.ts"], "out": "docs", "tsconfig": "tsconfig.json", + "sort": ["kind", "alphabetical"], + "kindSortOrder": ["Function"] } diff --git a/lib/papi-dts/package.json b/lib/papi-dts/package.json index 2d3bbc2c57..dbf32b2918 100644 --- a/lib/papi-dts/package.json +++ b/lib/papi-dts/package.json @@ -26,7 +26,7 @@ "main": "", "types": "papi.d.ts", "scripts": { - "build:docs": "npx typedoc", + "build:docs": "typedoc", "build": "tsc && prettier --write papi.d.ts && ts-node edit-papi-d-ts.ts", "build:clean": "rimraf papi.tsbuildinfo", "build:fresh": "npm run build:clean && npm run build", From 1aea275b368efc5e133db10071be162cbc70d645 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 16:14:39 -0500 Subject: [PATCH 10/17] use build script, and test with current branch --- .github/workflows/publish-docs.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index cf01878dff..3c7adc5495 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -4,6 +4,7 @@ on: push: branches: - main + - fix-publish-docs jobs: publish-docs: @@ -27,9 +28,9 @@ jobs: - name: Build documentation run: | # need to specify --out so pages links at /{their name} instead of at /docs cd lib/papi-components - npx typedoc --out papi-components + npm run build:docs -- --out papi-components cd ../papi-dts - npx typedoc --out papi-dts + npm run build:docs -- --out papi-dts cd ../../ mkdir docs-for-pages mv lib/papi-components/papi-components docs-for-pages From 2981dc84f9830cb410fb1af3e07bace52feeb0a0 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 17:47:55 -0500 Subject: [PATCH 11/17] small change to test re deploy --- lib/papi-dts/typedoc.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/papi-dts/typedoc.json b/lib/papi-dts/typedoc.json index 083cda5359..29a2fcd546 100644 --- a/lib/papi-dts/typedoc.json +++ b/lib/papi-dts/typedoc.json @@ -4,5 +4,5 @@ "out": "docs", "readme": "README.md", "logLevel": "Verbose", - "sort": ["kind", "alphabetical"] + "sort": ["kind", "alphabetical", "instance-first"] } From 2c4de7cbe9b175521b6f3201265ce29957255d13 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Tue, 5 Dec 2023 17:55:08 -0500 Subject: [PATCH 12/17] remove small change and only run this workflow on push to main --- .github/workflows/publish-docs.yml | 1 - lib/papi-dts/typedoc.json | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 3c7adc5495..180b02e63a 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -4,7 +4,6 @@ on: push: branches: - main - - fix-publish-docs jobs: publish-docs: diff --git a/lib/papi-dts/typedoc.json b/lib/papi-dts/typedoc.json index 29a2fcd546..083cda5359 100644 --- a/lib/papi-dts/typedoc.json +++ b/lib/papi-dts/typedoc.json @@ -4,5 +4,5 @@ "out": "docs", "readme": "README.md", "logLevel": "Verbose", - "sort": ["kind", "alphabetical", "instance-first"] + "sort": ["kind", "alphabetical"] } From 0f3d425b661df1d4525f97dce845ca20ae4d39e1 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Wed, 6 Dec 2023 10:13:36 -0500 Subject: [PATCH 13/17] test no jekyll --- .github/workflows/publish-docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 180b02e63a..0c6360e0b8 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -4,6 +4,7 @@ on: push: branches: - main + - fix-publish-docs jobs: publish-docs: @@ -34,6 +35,7 @@ jobs: mkdir docs-for-pages mv lib/papi-components/papi-components docs-for-pages mv lib/papi-dts/papi-dts docs-for-pages + touch docs-for-pages/.nojekyll - name: Deploy to GitHub Pages uses: JamesIves/github-pages-deploy-action@4.1.4 From f9578a61ffdd03641bc8ba0b33a1304720d33d23 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Wed, 6 Dec 2023 10:24:36 -0500 Subject: [PATCH 14/17] test landing page --- .github/workflows/publish-docs.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 0c6360e0b8..da5a2aae5a 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -35,7 +35,12 @@ jobs: mkdir docs-for-pages mv lib/papi-components/papi-components docs-for-pages mv lib/papi-dts/papi-dts docs-for-pages - touch docs-for-pages/.nojekyll + + - name: Add nojekyll + run: touch docs-for-pages/.nojekyll + + - name: Add landing page + run: cp README.md docs-for-pages - name: Deploy to GitHub Pages uses: JamesIves/github-pages-deploy-action@4.1.4 From a56034e6d22887a7609f95158fbfd0b6aa1c5208 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Wed, 6 Dec 2023 10:39:21 -0500 Subject: [PATCH 15/17] test index.html landing page --- .github/assets/github-pages-index.html | 41 ++++++++++++++++++++++++++ .github/workflows/publish-docs.yml | 4 ++- 2 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 .github/assets/github-pages-index.html diff --git a/.github/assets/github-pages-index.html b/.github/assets/github-pages-index.html new file mode 100644 index 0000000000..2107e1ea89 --- /dev/null +++ b/.github/assets/github-pages-index.html @@ -0,0 +1,41 @@ + + + + + + Platform.Bible API + + + +

Platform.Bible API

+ Go to papi-components + Go to papi-dts + + diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index da5a2aae5a..5968233cba 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -40,7 +40,9 @@ jobs: run: touch docs-for-pages/.nojekyll - name: Add landing page - run: cp README.md docs-for-pages + run: | + cp .github/assets/github-pages-index.html docs-for-pages + mv docs-for-pages/github-pages-index.html docs-for-pages/index.html - name: Deploy to GitHub Pages uses: JamesIves/github-pages-deploy-action@4.1.4 From 415fb0d10a104ffdc49cac1f56d2c8c4144d2046 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Wed, 6 Dec 2023 10:52:03 -0500 Subject: [PATCH 16/17] update landing page --- .github/assets/github-pages-index.html | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/.github/assets/github-pages-index.html b/.github/assets/github-pages-index.html index 2107e1ea89..5229e043b3 100644 --- a/.github/assets/github-pages-index.html +++ b/.github/assets/github-pages-index.html @@ -3,33 +3,38 @@ + Platform.Bible API From 4969de3118632d09dff6d726b3c3316b39d18a37 Mon Sep 17 00:00:00 2001 From: Jolie Rabideau Date: Wed, 6 Dec 2023 11:02:18 -0500 Subject: [PATCH 17/17] remove current branch from workflow --- .github/workflows/publish-docs.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 5968233cba..f5b40658be 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -4,7 +4,6 @@ on: push: branches: - main - - fix-publish-docs jobs: publish-docs: @@ -36,7 +35,7 @@ jobs: mv lib/papi-components/papi-components docs-for-pages mv lib/papi-dts/papi-dts docs-for-pages - - name: Add nojekyll + - name: Add nojekyll # needed so that HTML pages that start with _ do not cause 404 run: touch docs-for-pages/.nojekyll - name: Add landing page