add TypeDoc to project #148
Merged
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
jamie-lynch
reviewed
Jan 15, 2021
script/release
Outdated
| @@ -9,6 +9,7 @@ DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) | |||
| if npm whoami &>/dev/null; then | |||
| rm -rf ./lib | |||
| npm run release | |||
| npm run release:docs | |||
There was a problem hiding this comment.
As the release command fails at the point of trying to push to main, I'm not sure if it will ever execute this line or if it will fail and exit before getting there.
There was a problem hiding this comment.
Oh great point! Thoughts on possible solutions?
- Have a separate script and remember to run it
- Publish to GH Pages automatically via GH Actions, triggered by the creation of a GH tag/release
npm run release || trueto always have that statement exit cleanly- Something else
There was a problem hiding this comment.
I'd vote for the second one as:
- I will forget to run a separate script
- If it fails for another reason (like yesterday when the tests failed) we probably don't want to publish to docs
There was a problem hiding this comment.
Cool. Added a GH Actions workflow file now, which should deploy documentation to GH Pages whenever a new release is created.
TypeDoc will generate a documentation site which we can publish to github pages.
jamie-lynch
approved these changes
Jan 15, 2021
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.
What does this change?
TypeDoc will generate a documentation site which we can publish to GitHub Pages.
A new
script/docsscript is added to view docs locally andscript/releaseis updated to rungh-pagesto publish the generated site to GitHub Pages.Does this change require changes to existing projects or CDK CLI?
No.
How to test
script/docsHow can we measure success?
Published documentation 🎉 .
This will also encourage us to annotate our code properly, as noted here.
Have we considered potential risks?
n/a
Images
Index Page
Example page for
GuStackExample page for
GuStackw/out externals (AWS CDK properties) shown