Repository navigation
JavaDoc as HTML and JARs - #58
Merged
Merged
Conversation
AFAIU, this should build everything the default profile builds, but in addition also -source and -javadoc JAR files. I've added it to the regular build as well, since I guess one would want to know if something is failing in docs generation as well.
TODO: Validate contents, create a branch and PR
... with the updated contents of static/api-java/vX
* Update to version 0.0.2 * Update to version 0.1.0-SNAPSHOT --------- Co-authored-by: Maven Central Release Script <noreply+s4hana-cloud-sdk@sap.com>
This reverts commit ce1a678.
This reverts commit ce1a678.
* Update to version 0.0.2 * Update to version 0.1.0-SNAPSHOT --------- Co-authored-by: Maven Central Release Script <noreply+s4hana-cloud-sdk@sap.com>
- Leave it in the workflow commented with instructions, may come in handy at some point.
Also don't assume default branch is "main" always. From the discussion in the team, I picked up it may also be something like "main/v5" or similar.
stippi2
marked this pull request as ready for review
September 13, 2023 11:41
This reverts commit c9d1b90.
MatKuhr
reviewed
Sep 13, 2023
MatKuhr
left a comment
MatKuhr
left a comment
Member
There was a problem hiding this comment.
generally looks good! I don't understand everything, but we can verify things work correctly when switching development and publishing to OSSRH staging.
| # they require the JARs of all modules to work, so those need to be installed | ||
| run: | | ||
| mvn $MVN_CLI_ARGS install -DskipTests -DskipFormatting | ||
| python .pipeline/scripts/generate-javadoc-sourcepath-properties.py |
Member
There was a problem hiding this comment.
does it matter if this is run before or after install?
Member
Author
There was a problem hiding this comment.
Yes we need to run the script to generate the properties file before the install, otherwise we cannot generate the docs.
Member
Author
There was a problem hiding this comment.
Note, the properties file is not part of the repo but only generated on the fly.
| <h3>Key Features:</h3> | ||
| <ul> | ||
| <li>Abstractions for SAP Business Technology Platform features</li> | ||
| <li>Virtual Data Model for the S4/HANA APIs</li> |
Member
There was a problem hiding this comment.
This will need an update, but we can do that once everything is there. I added a note to https://github.com/SAP/cloud-sdk-java-backlog/issues/281
MatKuhr
approved these changes
Sep 14, 2023
Comment on lines
+19
to
+20
| <li><a href="/cloudplatform/package-summary.html">cloudplatform</a> contains platform specific features such as access to services, connectivity and resilience</li> | ||
| <li><a href="/s4hana/package-summary.html">s4hana</a> contains VDM representations of the S/4HANA APIs</li> |
Contributor
There was a problem hiding this comment.
These links don't work
This file contains hidden or 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
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.
BLI: https://github.com/SAP/cloud-sdk-java-backlog/issues/78
The generated aggregated JavaDoc will be appended as release asset and a PR will be created automatically to update the API docs in the SAP Cloud SDK documentation repo, if there are any changes.
The PR would look like this one: SAP/cloud-sdk#1521
A PR exists which adds an entry in the sidebar of the SAP Cloud SDK for Java documentation: SAP/cloud-sdk#1522