Add 'reason' parameter to lock() step#982
Merged
github-actions[bot] merged 24 commits intomasterfrom Apr 19, 2026
Merged
Conversation
This step allows pipelines to dynamically manage lockable resources: - Create new resources (createResource: true) - Delete existing resources (deleteResource: true) - Modify labels (setLabels, addLabels, removeLabels) - Set notes (setNote) Based on the original design from PR #305 by @gaspardpetit. Fixes #305
Allows users to specify a reason when locking a resource, displayed in
the lockable resources UI while the resource is locked.
Usage:
lock(resource: 'my-resource', reason: 'Running integration tests') {
// ...
}
Features:
- New 'reason' parameter on lock() step
- Reason displayed in UI status column while locked
- Reason cleared automatically when resource is unlocked
- Works with label-based and resource-based locking
- Reason preserved when lock request is queued
- Environment variable 'resourceLockReason' available in groovy scripts
Fixes #520
21 tasks
github-actions
Bot
added
enhancement
java
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
When a user reserves a resource via the Reserve button, they are now prompted to provide a reason. The reason is: - Stored in the lockReason field (shared with lock() step) - Displayed in the resources table - Cleared when the resource is unreserved Changes: - LockableResource: Add reserve(userName, reason) overload - LockableResourcesManager: Add reserve(resources, userName, reason) - doReserve: Read reason parameter from request - table.jelly: Show reason for reserved resources, add i18n template - lockable-resources.js: Prompt for reason on reserve action - table.properties: Add dialog messages
Contributor
Author
|
Manual verification OK: 
|
Contributor
|
⏸️ Auto-merge countdown PAUSED: CI checks are not passing. The countdown will resume when all checks are green. |
…ci/lockable-resources-plugin into feature/lock-step-reason
github-actions
Bot
added
merge-in-2-days-without-review
Contributor
|
⏳ Auto-merge countdown: This PR will be auto-approved in 2 day(s) if no review is submitted. |
github-actions
Bot
added
merge-in-1-day-without-review
Contributor
|
|
github-actions
Bot
removed
the
merge-in-1-day-without-review
Contributor
|
✅ Auto-approved: No review received within 3 days. Merging now. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
I think this screenshot clearly shows that the column widths really need some tweaking. There is simply way too much wasted space in some columns and unnecessary squeezing in others. https://github.com/jenkinsci/lockable-resources-plugin/blob/1509.va_6b_5b_5cb_0b_40/src/main/resources/org/jenkins/plugins/lockableresources/actions/LockableResourcesRootAction/tableResources/table.jelly#L63-L69 simply doesn't look good in most cases. |
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
3 participants
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.
Summary
Allows users to specify a reason when locking a resource, displayed in the lockable resources UI while the resource is locked.
Usage
\\groovy
lock(resource: 'my-resource', reason: 'Running integration tests') {
// ...
}
\\
Features
eason\ parameter on \lock()\ step
esourceLockReason\ available in groovy scripts
Testing
Documentation
Screenshots
The lock reason is displayed in the Status column of the lockable resources overview page when a resource is locked.
Fixes #520
Fixes #426
@Massakera Thank you for the original PR and idea in #520. I've reimplemented this feature to resolve merge conflicts and align with the current codebase. You can close PR #520 now.