Explain how to adjust the home directory #7759
Open
+13
−1
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
probot-autolabeler
bot
added
the
documentation
krisstern
reviewed
Dec 16, 2024
| TODO: Write this section. | ||
|
|
||
| If you want to adjust the `JENKINS_HOME` within a test, you can make use of the `JenkinsRule`-methods `withExistingHome()` or `withNewHome()`. | ||
| Let's assume in the directory "src/test/resources/home" everything is prepared for a good test suite, and you want to use that. |
There was a problem hiding this comment.
Suggested change
| Let's assume in the directory "src/test/resources/home" everything is prepared for a good test suite, and you want to use that. | |
| Let's assume in the directory "src/test/resources/home" everything is prepared for a good test suite, which you should use. |
| public JenkinsRule j = new JenkinsRule().withExistingHome(new File("src/test/resources/home")); | ||
| ---- | ||
|
|
||
| If you need a fresh `JENKINS_HOME` you can use `withNewHome()` which creates a fresh home, what the default of the `JenkinsRule()` at the beginning is. |
There was a problem hiding this comment.
Suggested change
| If you need a fresh `JENKINS_HOME` you can use `withNewHome()` which creates a fresh home, what the default of the `JenkinsRule()` at the beginning is. | |
| If you need a fresh `JENKINS_HOME` you can use `withNewHome()` which creates a fresh home, which is by default what the `JenkinsRule()` at the beginning is. |
MarkEWaite
approved these changes
Dec 16, 2024
| @@ -367,7 +367,19 @@ report.copyFrom(getClass().getResourceAsStream("lint-results_r20.xml")); | |||
| ---- | |||
|
|
|||
| ==== Customizing the `JENKINS_HOME` Directory | |||
| TODO: Write this section. | |||
|
|
|||
| If you want to adjust the `JENKINS_HOME` within a test, you can make use of the `JenkinsRule`-methods `withExistingHome()` or `withNewHome()`. | |||
There was a problem hiding this comment.
These methods seem to be rarely used. A GitHub search showed only two usages in the jenkinsci organization.
An optional minor phrasing change. I'm not sure of the preferred replacement for these test methods, but I suspect that there are preferred replacements..
Suggested change
| If you want to adjust the `JENKINS_HOME` within a test, you can make use of the `JenkinsRule`-methods `withExistingHome()` or `withNewHome()`. | |
| If you want to adjust the `JENKINS_HOME` within a test, use the `JenkinsRule`-methods link:https://javadoc.jenkins.io/component/jenkins-test-harness/org/jvnet/hudson/test/JenkinsRule.html#withExistingHome(java.io.File)[`withExistingHome()`] or link:https://javadoc.jenkins.io/component/jenkins-test-harness/org/jvnet/hudson/test/JenkinsRule.html#withNewHome()[`withNewHome()`]. |
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.
Explain how to adjust the home directory.
Not sure how broadly it is used, but there was a TODO and I thought describing it might not hurt.