Skip to content

[JENKINS-13423] Environment Variables documentation missing GIT_COMMIT and GIT_BRANCH#434

Closed
dserodio wants to merge 1 commit into
jenkinsci:masterfrom
dserodio:master
Closed

[JENKINS-13423] Environment Variables documentation missing GIT_COMMIT and GIT_BRANCH#434
dserodio wants to merge 1 commit into
jenkinsci:masterfrom
dserodio:master

Conversation

@dserodio
Copy link
Copy Markdown

This commit adds documentation for these, copied from the Jenkins Wiki but with "Gitish" replaced with "SHA-1 hash".

@orrc
Copy link
Copy Markdown
Member

orrc commented Apr 11, 2012

Probably this information doesn't belong in the core documentation, because the Git Plugin isn't part of core.

@dserodio
Copy link
Copy Markdown
Author

I agree it's not part of core, but this is documented in the Jenkins "core" wiki. I think the static doc. included in Jenkins should have the same variables as the Wiki page I linked above.

Also, Git is very popular so I think this would be helpful for many people.

@dserodio
Copy link
Copy Markdown
Author

PS.: Nice avatar :)

@orrc
Copy link
Copy Markdown
Member

orrc commented Apr 12, 2012

Well, the wiki is a wiki -- someone passing by just happened to add that info a few months ago.

I wonder if the list of available environment variables can somehow be dynamically generated, similar to some plugins which interact with the token-macro plugin do.

@kohsuke
Copy link
Copy Markdown
Member

kohsuke commented Apr 14, 2012

I hesitated a bit to comment without first changing my avatar, but anyway, I agree with orrc that the list should be dynamically generated.

@kohsuke
Copy link
Copy Markdown
Member

kohsuke commented Apr 14, 2012

I pushed pull-434.2 that contains just the contract part of it.

@kohsuke
Copy link
Copy Markdown
Member

kohsuke commented Jun 11, 2012

This change is merged toward 1.471. See jenkinsci/subversion-plugin@8ca12ea for an example of how to contribute environment variables to the help page from plugins

@kohsuke kohsuke closed this Jun 11, 2012
@dserodio
Copy link
Copy Markdown
Author

Great! May I implement the environment variables contribution for the Git plugin?

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.

3 participants