chore: Setup typedoc to build references.json and configure release workflow to update docs site #14255
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
stocaaro
changed the title
15 tasks
AllanZhengYP
reviewed
Mar 6, 2025
typedoc.json
Outdated
| "packages/aws-amplify/storage", | ||
| "packages/aws-amplify/storage/server", | ||
| "packages/aws-amplify/utils", | ||
| "packages/core", |
There was a problem hiding this comment.
For some reason this line will cause our API reference page: https://aws-amplify.github.io/amplify-js/api/ to show the internal package @aws-amplify/core.
I'm thinking of using a separate typedoc config to generate reference.json that includes every thing doc side needs.
There was a problem hiding this comment.
Migrated to using a different configuration file for the reference.json file.
joon-won
approved these changes
Mar 18, 2025
|
Looks good to me |
AllanZhengYP
approved these changes
Mar 19, 2025
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.
Description of changes
Automate the regeneration of the docs site references with each release.
Description of how you validated changes
I ran a truncated process on my work to demonstrate it works: https://github.com/stocaaro/amplify-js/actions/runs/13843396723, which results in this PR being generated on my fork stocaaro/docs#10
Checklist
yarn testpassesChecklist for repo maintainers
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.