Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 15 additions & 37 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,13 @@ jobs:
with:
ref: gh-pages

- name: tar the existing docs
- name: remove all symbolic links from root if present
run: |
mkdir -p ./docs
tar -cvf documentation.tar ./docs
find . -maxdepth 1 -type l -delete

- name: tar the existing docs from root
run: |
tar -cvf documentation.tar

- name: create a document artifact
uses: actions/upload-artifact@v4
Expand All @@ -33,51 +36,26 @@ jobs:
- name: Checkout src
uses: actions/checkout@v5

- run: mkdir -p ./docs
- name: Download the existing documents artifact
uses: actions/download-artifact@v5
with:
name: documentation
- run: rm -rf ./docs # delete previous docs folder present
- run: mkdir ./docs # create an empty docs folder
- run: tar -xf documentation.tar -C ./docs
- run: rm -f documentation.tar

- name: Setup
uses: ./.github/actions/setup

- name: Build documents
run: yarn docs #set up 'docs' build script in your package.json

- name: Run cleanup and manage document versions
run: node scripts/manage-doc-versions.js

- name: tar the new docs
run: tar -cvf newdocumentation.tar ./docs

- name: create a new document artifact
uses: actions/upload-artifact@v4
with:
name: newdocumentation
path: newdocumentation.tar

commit: # commit the old and new merged documents to gh-pages/docs
needs: build
runs-on: ubuntu-latest
steps:
- name: checkout the gh-pages repo
uses: actions/checkout@v5
with:
ref: gh-pages
- name: Remove all the symbolic links from docs folder
run: find ./docs -type l -delete

- run: mkdir -p ./docs
- name: Download the new documents artifact
uses: actions/download-artifact@v5
with:
name: newdocumentation
- run: tar -xf newdocumentation.tar -C ./docs
- name: Run cleanup and manage document versions
run: node scripts/manage-doc-versions.js

- name: commit
run: |
git config --global user.email "[email protected]"
git config --global user.name "Continuous Integration"
git add .
git commit -m "CI updated the documentation"
git push
- name: Deploy to github pages using gh-pages
run: npx gh-pages -d docs
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,5 @@ android/generated
# Other
dist/
out/
coverage/
coverage/
docs/
1 change: 0 additions & 1 deletion docs/.typedoc-plugin-versions

This file was deleted.

1 change: 0 additions & 1 deletion docs/.version

This file was deleted.

2 changes: 0 additions & 2 deletions docs/dev/assets/hierarchy.js

This file was deleted.

173 changes: 0 additions & 173 deletions docs/dev/assets/highlight.css

This file was deleted.

Loading