Fix readme generation when using snippet_files #6008
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
github-actions
bot
added
Javascript-v3
DavidSouther
approved these changes
Jan 26, 2024
DavidSouther
added
On Call Review needed
|
@DavidSouther I have fixed the quotes |
DennisTraub
force-pushed
the
fix/readme-generation
branch
from
aee842c to
de5553d
Compare
meyertst-aws
added
On Call Review complete
meyertst-aws
force-pushed
the
fix/readme-generation
branch
from
de5553d to
903209d
Compare
max-webster
pushed a commit
to max-webster/aws-doc-sdk-examples
that referenced
this pull request
Mar 15, 2024
* Bug fix: Remove redundant path from snippet_files before rendering readmes Co-authored-by: Dennis Traub <[email protected]>
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 PR fixes a bug in the readme generation:
When using
snippet_filesinstead ofsnippet_tags, the readme generation produced broken links for the respective actions and scenarios because they start with[language]/example_code/even though the READMEs already are in that path.This bug has led to broken links in multiple READMEs for Rust and JavaScript (EC2, Auto-Scaling, ELBv2, Lambda, Bedrock, and IAM).
I've patched scanner.py so that it removes the leading
[language]/example_code, fixing the links for all affected single-service action and scenarios, and optionally adding../cross-services/, fixing the links for all affected cross-service scenarios.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.