ci: use typedoc for docs #1362
Merged
ci: use typedoc for docs #1362
Conversation
This file contains 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
cristiand391
commented
Sep 20, 2023
| git fetch origin v2-docs:v2-docs | ||
| git worktree add docs v2-docs | ||
| npx typedoc --out docs/tmp | ||
| cp -r docs/tmp/* docs/tmp/.. |
There was a problem hiding this comment.
dev-scripts uses shelljs.mv:
https://github.com/forcedotcom/dev-scripts/blob/1784d122fce7fd293745a618eee33a98be3476a0/bin/sf-docs.js#L49
shelljs: https://github.com/shelljs/shelljs#mvoptions--source_array-dest
but mv -f will not overwrite files so we just copy and then delete them.
https://askubuntu.com/a/269818
There was a problem hiding this comment.
also, generating docs in docs/tmp and then moving them back to docs is just to not mess the git working tree in docs
shetzel
approved these changes
Sep 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds
publish-docsworkflow to build documentation from code using typedoc.TODO
v2-docsbranch as for GH pages here (https://github.com/jsforce/jsforce/settings/pages)How to test:
Go to https://github.com/jsforce/jsforce/actions and run the
publish-docsworkflow, site should be up here:https://jsforce.github.io/jsforce/ (this is already deployed from previous testing, check the
v2-docsbranch to see it actually committed the changes).This PR also removes CircleCI config file
our GHA workflow already covers browser/node test scenarios
@W-9127316@