ts(docs): Add typedoc to client hosted with GHPages #648
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| name: PUBLISH DOCS | ||
| on: | ||
| workflow_dispatch: | ||
| workflow_call: | ||
| release: | ||
| types: [published] | ||
| permissions: | ||
| contents: write # allows the 'Commit' step without tokens | ||
|
|
||
| jobs: | ||
| get_history: # create an artifact from the existing documentation builds | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: get the gh-pages repo | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| ref: gh-pages | ||
|
|
||
| - name: tar the existing docs | ||
| run: | | ||
| mkdir -p ./docs | ||
| tar -cvf documentation.tar ./docs | ||
|
|
||
| - name: create a document artifact | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: documentation | ||
| path: documentation.tar | ||
|
|
||
| build: # builds the distribution and then the documentation | ||
| needs: get_history | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout src | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - run: mkdir -p ./docs | ||
| - name: Download the existing documents artifact | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: documentation | ||
| - run: tar -xf documentation.tar ./docs -C ./docs | ||
|
Contributor
There was a problem hiding this comment. Is there a reason we want to only untar things that start with ./docs? (probably fine given how the archive is created, but maybe would be confusing if we add more dirs later and they don't show up?)
Contributor
Author
There was a problem hiding this comment. this is just for GH pages so yeah just that one |
||
|
|
||
| - name: Build | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 16.x | ||
| cache: 'npm' | ||
| - run: npm ci | ||
| - run: npm run build # set up 'build' script in your package.json | ||
|
|
||
| - name: Build documents | ||
| run: npm run docs #set up 'docs' build script in your package.json | ||
|
|
||
| - name: tar the new docs | ||
| run: tar -cvf newdocumentation.tar ./docs | ||
|
|
||
| - name: create a new document artifact | ||
| uses: actions/upload-artifact@v3 | ||
| 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@v3 | ||
| with: | ||
| ref: gh-pages | ||
|
|
||
| - run: mkdir -p ./docs | ||
| - name: Download the new documents artifact | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: newdocumentation | ||
| - run: tar -xf newdocumentation.tar ./docs -C ./docs | ||
|
Contributor
There was a problem hiding this comment. same comment here on the ./docs arg |
||
|
|
||
| - name: commit | ||
| run: | | ||
| git config --global user.email "username@users.noreply.github.com" | ||
| git config --global user.name "Continuous Integration" | ||
| git add . | ||
| git commit -m "CI updated the documentation" | ||
| git push | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,3 +12,4 @@ dist-deno | |
| .DS_Store | ||
| coverage-objects | ||
| object-coverage-report.json | ||
| docs | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
|
|
||
| const sdkJs = | ||
| process.env['DIST_PATH'] ? | ||
| path.resolve(process.env['DIST_PATH'], 'sdk.js') | ||
| : path.resolve(__dirname, '..', '..', 'dist', 'sdk.js'); | ||
|
|
||
| let before = fs.readFileSync(sdkJs, 'utf8'); | ||
| let after = before.replace( | ||
| /^\s*exports\.default\s*=\s*(\w+)/m, | ||
| 'exports = module.exports = $1;\nexports.default = $1', | ||
| ); | ||
| fs.writeFileSync(sdkJs, after, 'utf8'); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if there is no .docs dir, should we create an error rather than an empty tar file? I assume things would just fail if the tar command exits with nonzero status, so just taking out the mkdir would do the trick?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is within the GH page repo, so if it doesn't exist it makes an empty one if it does it tars it up