-
Notifications
You must be signed in to change notification settings - Fork 583
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.
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
[CI] Remove Maven profile full in favour of using docs for all document generation. #6007
[CI] Remove Maven profile full in favour of using docs for all document generation. #6007
Conversation
.github/workflows/ci-pr.yml
Outdated
@@ -17,7 +17,7 @@ jobs: | |||
shell: bash | |||
timeout-minutes: 75 | |||
run: | | |||
./mvnw -B -s .github/settings.xml -Pdocs clean install --no-transfer-progress | |||
./mvnw -B -s .github/settings.xml -Pfull,docs clean install --no-transfer-progress |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is full
vs. docs
? I guess I don't understand how full
fulfills the PR description of executes rest-docs generation as well
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't choose the name. We can change to rest-docs
to ensure it is unambiguous.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Having checked:
docs
means javadocsfull
means all rest-docs and asciidocs.
How about we rather use javadocs
and fulldocs
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense to me . @onobc what do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@corneil, Love the renames.
But, when we make these changes we will have to update the following files:
- ci.yml
- build-snapshot-worker.yml
- build-docs.yml
- spring-cloud-skipper/README.adoc
- appendix-building.adoc
…nd other document generation.
<skipTests>false</skipTests> | ||
<includes> | ||
<include>**/*Documentation.java</include> | ||
<include>**/*Tests.java</include> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably want to include the **/*Tests.java
to the docs plugin below. WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've changed to the surefire in docs
profile to use the package
phase which means test
phase executes normal unit tests and package
phase generates the snippets.
When -DskipTests
is present the normal test phase is skipped. When -Pdocs is not provides then the snippets are not generated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks Great! One small question below.
… skip tests and generate documentation but allow for normal tests to execute id -DskipTests are not specified.
…incorrect assumption of where the resources are located. Disable test suites that are not needed to create documentation snippets.
The latests commit fixes tests for the actual resources present that do work when doing local deployments. |
We have a pass locally fails in CI-PR situation. 😢 |
Improved surefire report plugin config. Fix last failing tests.
7cf5109
to
d1d71a1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. @corneil Thanks for all your hard work on this!
Rebased, Squashed, Merged. @corneil Thanks for the hard work on this. |
In
spring-cloud-skipper-server-core
I've changed to the surefire indocs
profile to use thepackage
phase which meanstest
phase executes normal unit tests andpackage
phase generates the snippets.When
-DskipTests
is present the normal test phase is skipped. When-Pdocs
is not provided then the snippets are not generated.