-
Notifications
You must be signed in to change notification settings - Fork 384
JENKINS-58313 Add source commit and branch name #250
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c559689
JENKINS-58313 Add source commit
timja f11fcb4
Merge branch 'master' into JENKINS-58313-add-source-commit
timja ff8e92d
Use getRevision
timja fc051d0
Merge branch 'master' into JENKINS-58313-add-source-commit
timja 2817466
Make optional
timja 139cae8
Whitespace fixes
timja File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -98,7 +98,7 @@ | |
<groupId>org.jenkins-ci.plugins</groupId> | ||
<artifactId>branch-api</artifactId> | ||
<version>2.1.2</version> | ||
<scope>test</scope> | ||
<optional>true</optional> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Optional is not a good plan. It complicates classloading. Should just be an extension plugin |
||
</dependency> | ||
<dependency> | ||
<groupId>org.jenkins-ci.plugins</groupId> | ||
|
79 changes: 79 additions & 0 deletions
79
src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubEnvContributor.java
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
/* | ||
* The MIT License | ||
* | ||
* Copyright 2019 Tim Jacomb | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to deal | ||
* in the Software without restriction, including without limitation the rights | ||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
* copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in | ||
* all copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
* THE SOFTWARE. | ||
*/ | ||
package org.jenkinsci.plugins.github_branch_source; | ||
|
||
import hudson.EnvVars; | ||
import hudson.Extension; | ||
import hudson.model.EnvironmentContributor; | ||
import hudson.model.ItemGroup; | ||
import hudson.model.Job; | ||
import hudson.model.TaskListener; | ||
import java.util.HashMap; | ||
import java.util.Map; | ||
import javax.annotation.Nonnull; | ||
import jenkins.branch.BranchProjectFactory; | ||
import jenkins.branch.MultiBranchProject; | ||
import jenkins.plugins.git.AbstractGitSCMSource; | ||
import jenkins.scm.api.SCMRevision; | ||
import org.kohsuke.accmod.Restricted; | ||
import org.kohsuke.accmod.restrictions.NoExternalUse; | ||
|
||
@Extension(optional = true) | ||
@Restricted(NoExternalUse.class) | ||
public class GitHubEnvContributor extends EnvironmentContributor { | ||
|
||
private static final String CHANGE_SOURCE_COMMIT_ID = "CHANGE_SOURCE_COMMIT_ID"; | ||
private static final String CHANGE_MERGE_COMMIT_ID = "CHANGE_MERGE_COMMIT_ID"; | ||
private static final String CHANGE_BASE_COMMIT_ID = "CHANGE_BASE_COMMIT_ID"; | ||
private static final String CHANGE_BRANCH = "CHANGE_BRANCH"; | ||
|
||
@SuppressWarnings("unchecked") | ||
public void buildEnvironmentFor(Job job, @Nonnull EnvVars envs, @Nonnull TaskListener listener) { | ||
ItemGroup parent = job.getParent(); | ||
if (parent instanceof MultiBranchProject) { | ||
BranchProjectFactory projectFactory = ((MultiBranchProject) parent).getProjectFactory(); | ||
SCMRevision revision = projectFactory.getRevision(job); | ||
|
||
Map<String, String> envValues = new HashMap<>(); | ||
if (revision instanceof PullRequestSCMRevision) { | ||
PullRequestSCMRevision pullRequestSCMRevision = (PullRequestSCMRevision) revision; | ||
|
||
envValues.put(CHANGE_SOURCE_COMMIT_ID, pullRequestSCMRevision.getPullHash()); | ||
envValues.put(CHANGE_MERGE_COMMIT_ID, pullRequestSCMRevision.getMergeHash()); | ||
envValues.put(CHANGE_BASE_COMMIT_ID, pullRequestSCMRevision.getBaseHash()); | ||
|
||
|
||
} else if (revision instanceof AbstractGitSCMSource.SCMRevisionImpl) { | ||
AbstractGitSCMSource.SCMRevisionImpl gitRevision = (AbstractGitSCMSource.SCMRevisionImpl) revision; | ||
|
||
envValues.put(CHANGE_SOURCE_COMMIT_ID, gitRevision.getHash()); | ||
envValues.put(CHANGE_BRANCH, revision.getHead().getName()); | ||
|
||
} else { | ||
throw new IllegalArgumentException("did not recognize " + revision); | ||
} | ||
envs.putAll(envValues); | ||
} | ||
} | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That you need to add a hard dependency on branch-api suggests this change should be an extension plugin and not in the core plugin. SCM implementations shouldn't be tied to orthogonal consumer concepts like branch-api