Add missing symbol on descriptor (#142)

jenkinsci · Oct 1, 2024 · e76ee8d · e76ee8d
1 parent 69708a7
commit e76ee8d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -35,12 +35,20 @@ Select *Set Jenkins user build variables* and reference the variables during the
 
 ```groovy
 node {
-  wrap([$class: 'BuildUser']) {
+  withBuildUser {
     def user = env.BUILD_USER_ID
   }
 }
 ```
 
+or with declarative option:
+
+```groovy
+options {
+  withBuildUser()
+}
+```
+
 ## Changelog
 
 Release notes are available in [GitHub Releases](https://github.com/jenkinsci/build-user-vars-plugin/releases) since July 2020 (build-user-vars plugin 1.6 and later).

diff --git a/src/main/java/org/jenkinsci/plugins/builduser/BuildUser.java b/src/main/java/org/jenkinsci/plugins/builduser/BuildUser.java
@@ -20,6 +20,7 @@
 import jenkins.branch.BranchIndexingCause;
 import jenkins.model.Jenkins;
 import jenkins.tasks.SimpleBuildWrapper;
+import org.jenkinsci.Symbol;
 import org.jenkinsci.plugins.builduser.varsetter.IUsernameSettable;
 import org.jenkinsci.plugins.builduser.varsetter.impl.*;
 import org.kohsuke.accmod.Restricted;
@@ -134,6 +135,7 @@ private static void handleOtherCausesOrLogWarningIfUnhandled(@NonNull Run<?, ?>
     }
 
     @Extension
+    @Symbol("withBuildUser")
     public static class DescriptorImpl extends BuildWrapperDescriptor {
         @Override
         public boolean isApplicable(AbstractProject<?, ?> item) {