Skip to content
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

Jump to bottom

chore(codegen): update documentation with link to additional starters #1469

Merged
merged 10 commits into from
Jan 25, 2023
Merged

chore(codegen): update documentation with link to additional starters #1469

merged 10 commits into from
Jan 25, 2023

Conversation

emmileaf
Copy link
Contributor

@emmileaf emmileaf commented Jan 19, 2023 •
edited
Loading

This PR reverts #1369 - prepare to merge this when ready to release.
Merge order: Initial PR with preview modules (#1517 > this PR > #1415.

@emmileaf emmileaf changed the title [do not merge] update documentation with link to additional starters [do not merge] chore(codegen): update documentation with link to additional starters Jan 20, 2023
@emmileaf emmileaf marked this pull request as ready for review January 23, 2023 14:57
meltsufin
meltsufin approved these changes Jan 23, 2023
View reviewed changes
docs/src/main/asciidoc/getting-started.adoc
@@ -68,6 +68,9 @@ You do *not* need to include the underlying `spring-cloud-gcp-pubsub` dependency

A summary of these artifacts are provided below.

Aside from these modules, we also provide additional starters with auto-configurations to various Google Client Libraries.
Refer for the full list https://github.com/GoogleCloudPlatform/spring-cloud-gcp/tree/main/spring-cloud-previews/README.md[here].
Copy link
Member

Choose a reason for hiding this comment

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

It might be possible to construct a URL based on {project-version}, like:
https://github.com/GoogleCloudPlatform/spring-cloud-gcp/tree/v{project-version}/spring-cloud-previews/README.md.
It's just a potential alternative for generating the list directly into the docs. However, it would need to be conditional on the project version being non-snapshot. So, let's not do that now.

This was referenced Jan 24, 2023
Merged
Merged
@blakeli0
Copy link
Contributor

nit: This could be a doc PR instead of chore.

@emmileaf
Copy link
Contributor Author

nit: This could be a doc PR instead of chore.

Agreed this is more of a docs PR - the reason for using the chore(codegen) prefix for now is so only one codegen PR's commit message gets picked up by release-please (#1495), containing the line to show up in release notes for this initial introduction of preview starters.

@emmileaf emmileaf changed the title [do not merge] chore(codegen): update documentation with link to additional starters chore(codegen): update documentation with link to additional starters Jan 25, 2023
@emmileaf emmileaf mentioned this pull request Jan 25, 2023
Merged
emmileaf pushed a commit that referenced this pull request Jan 25, 2023
@cloud-java-bot
feat(codegen): additional autoconfiguration starter modules for previ…
2a8b103 
…ew (#1517)

This is an initial PR for additional starters (for preview) that provide dependencies and auto-configurations for working with corresponding Google Client Libraries.
* Documentation and release profile changes to follow in #1469, #1415
@emmileaf
Copy link
Contributor Author

Copied README.md changes to added template file, per follow-up to #1525 (comment).

@sonarcloud
Copy link

sonarcloud bot commented Jan 25, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@emmileaf emmileaf merged commit 3146b95 into main Jan 25, 2023
@emmileaf emmileaf deleted the codegen-add-docs branch January 25, 2023 19:16
@emmileaf emmileaf mentioned this pull request Jan 26, 2023
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@meltsufin meltsufin meltsufin approved these changes

@diegomarquezp diegomarquezp diegomarquezp approved these changes

Assignees
No one assigned
Labels
codegen
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@emmileaf @blakeli0 @meltsufin @diegomarquezp