Skip to content

[JENKINS-75072] Support documentation of EnvVar contributed by GitSCMExtension #3867

@jenkins-infra-bot

Description

@jenkins-infra-bot

As a Jenkins plugin developer, when I provide an implementation of the GitSCMExtension extension point with environment variables via the populateEnvironmentVariables method, I also need to be able to provide documentation.
Such documentation I would expect to contribute to the page under the "Pipeline Syntax" -> "Global Variable Reference" menu under the "env" pipeline step.

Actually Jenkins core lookup for a buildEnv.jelly or buildEnv.groovy resource in the classpath of the plugin that provides an entension of EnvironmentContributor or SCM.
Since the SCM implementation (GitSCM) is provided by the git-plugin, any buildEnv.groovy resource in the plugin where the implementation of GitSCMExtension is placed is not taken into account.


Originally reported by nfalco, imported from: Support documentation of EnvVar contributed by GitSCMExtension
  • status: Open
  • priority: Minor
  • component(s): git-plugin
  • resolution: Unresolved
  • votes: 0
  • watchers: 4
  • imported: 2025-12-02
Raw content of original issue

As a Jenkins plugin developer, when I provide an implementation of the GitSCMExtension extension point with environment variables via the populateEnvironmentVariables method, I also need to be able to provide documentation. Such documentation I would expect to contribute to the page under the "Pipeline Syntax" -> "Global Variable Reference" menu under the "env" pipeline step.

Actually Jenkins core lookup for a buildEnv.jelly or buildEnv.groovy resource in the classpath of the plugin that provides an entension of EnvironmentContributor or SCM. Since the SCM implementation (GitSCM) is provided by the git-plugin, any buildEnv.groovy resource in the plugin where the implementation of GitSCMExtension is placed is not taken into account.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions