Skip to content

Add code examples to package summary pages in API refs guide #6625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
S-Saranya1 wants to merge 1 commit into
base: master
Choose a base branch
from
+5,354 −0
Open

Add code examples to package summary pages in API refs guide #6625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions buildspecs/release-javadoc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ phases:
- MODULES_TO_SKIP_FORMATTED=$(echo $MODULES_TO_SKIP | sed 's/,/,!:/g' | sed 's/^/!:/')
- mvn clean install javadoc:aggregate -B -Ppublic-javadoc -Dcheckstyle.skip -Dspotbugs.skip -DskipTests -Ddoclint=none -pl $MODULES_TO_SKIP_FORMATTED
- RELEASE_VERSION=`mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec`
- python3 ./scripts/code_examples/inject_examples.py --exampleMetadata ./codegen/src/main/resources/software/amazon/awssdk/codegen/example-meta.json --docsPath ./target/site/apidocs/
Copy link
Contributor

@zoewangg zoewangg Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have we considered updating codegen code to link to the examples, similar to #6626

https://github.com/aws/aws-sdk-java-v2/blob/master/codegen/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/PackageInfoGeneratorTasks.java#L29

Copy link
Contributor Author

@S-Saranya1 S-Saranya1 Dec 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, considered updating PackageInfoGeneratorTasks.java, but that approach would modify all package-info.java files for all services (70+ files). After codegen, all these generated files would contain code examples in their javadoc comments. Felt it was unnecessary to embed code examples content directly in package-info.java files, as these files should focus on package-level information rather than usage examples. Also, modifying these many files would increase the Java SDK JAR size, even though minimal. Felt post-processing approach is cleaner. WDYT?

-
- aws s3 sync target/site/apidocs/ $DOC_PATH/$RELEASE_VERSION/ --acl="public-read"
- aws s3 cp ./scripts/crosslink_redirect.html $DOC_PATH/$RELEASE_VERSION/ --acl="public-read"
Expand Down
Loading
Loading