Skip to content

Add help text for the freestyle wrapper's credentials field#35

Merged
jochen-testingbot merged 1 commit into
masterfrom
ux-credentials-help
Jul 16, 2026
Merged

Add help text for the freestyle wrapper's credentials field#35
jochen-testingbot merged 1 commit into
masterfrom
ux-credentials-help

Conversation

@jochen-testingbot

@jochen-testingbot jochen-testingbot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

What

The freestyle Build Environment option had help on the tunnel checkbox (help-useTunnel.html) but none on the TestingBot Credentials dropdown. Adds help-credentialsId.html (matching the wording style of the pipeline steps' existing credential help) so the ? icon explains what the credential is for and which env vars it exposes.

Validation

mvn -DskipTests verify clean. Via hpi:run, /descriptorByName/testingbot.TestingBotBuildWrapper/help/credentialsId returns the help HTML (HTTP 200); the existing useTunnel help still returns 200 (no regression).

Summary by CodeRabbit

  • Documentation
    • Added help text explaining how to configure TestingBot credentials in Jenkins.
    • Documented the environment variables used to expose the credentials during builds.
    • Clarified that the credentials enable the TestingBot Tunnel when it is turned on.

The freestyle Build Environment option had help for the tunnel checkbox but not
for the credentials dropdown. Add help-credentialsId.html (consistent with the
pipeline steps' help) so the ? icon explains what the credential is used for and
which env vars it exposes.
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f18debb8-8d94-4504-b813-6a100d2b1cf4

📥 Commits

Reviewing files that changed from the base of the PR and between 3f2313b and 3004a74.

📒 Files selected for processing (1)
  • src/main/resources/testingbot/TestingBotBuildWrapper/help-credentialsId.html

📝 Walkthrough

Walkthrough

Added Jenkins help text explaining where TestingBot credentials are configured, which environment variables expose them, and how they support TestingBot Tunnel startup.

Changes

Credentials help

Layer / File(s) Summary
Document credential sourcing and tunnel usage
src/main/resources/testingbot/TestingBotBuildWrapper/help-credentialsId.html
Adds help text describing Jenkins credential storage, key/secret environment variables, and tunnel startup usage.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the new help text added for the wrapper’s credentials field.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Comment @coderabbitai help to get the list of available commands.

@jochen-testingbot
jochen-testingbot merged commit b0cfb0e into master Jul 16, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant