Implement Auto-Publishing of Docs to GitHub Pages (Issue #333) #340
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
TechWizard9999
requested review from
frankhinek,
csuwildcat and
mistermoe
as code owners
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
frankhinek
suggested changes
Dec 8, 2023
Comment on lines
+3
to
+7
| on: | ||
| push: | ||
| tags: | ||
| - '*' | ||
| workflow_dispatch: |
There was a problem hiding this comment.
Seems like we'd only want this to run when a commit on main is tagged, correct?
Otherwise tagging a release candidate on a branch or any other tag on a non-main branch would update docs
Co-authored-by: Frank Hinek <[email protected]>
Co-authored-by: Frank Hinek <[email protected]>
Co-authored-by: Frank Hinek <[email protected]>
Closed
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.
This pull request addresses Issue #333, which involves setting up automatic documentation generation and publishing to GitHub Pages using Typedoc and GitHub Actions.
Typedoc Setup: Added Typedoc as a dev dependency and configured it to generate documentation from the TypeScript source files.
GitHub Actions Workflow: Created a new workflow (publish-docs.yml) under .github/workflows/ to automate the documentation deployment process. This workflow is triggered on new tag pushes and manual dispatches.
Documentation Configuration: Included a typedoc.json file with the necessary settings for documentation generation.