[JIRA] (JENKINS-48822) Make git plugin browser URL guessing clearer and easier to understand

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand I want to contribute on this issue. From where should I start ? Add Comment

This message was sent by Atlassian Jira (v7.13.6#713006-sha1:cc4451f)

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

Thanks for your desire to contribute on this issue. That is wonderful! I think you should take the following steps: Assign the issue to yourself and change its state to "In Progress" so that others know you are working on it Clone and compile the git plugin based on the contributing guide Identify the location in the code where Freestyle ("old style") jobs determine the browser is "no browser" and replace it with inference logic based on the repository URL Investigate if the GitStep can be extended to infer the browser class from the repository URL as well Define a Jenkins extension point for the browser inference logic

Add Comment

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite edited a comment on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

Thanks for your desire to contribute on this issue.  That is wonderful! I think you should take the following steps:

# Assign the issue to yourself and change its state to "In Progress" so that others know you are working on it # Clone and compile the [git plugin|https://plugins.jenkins.io/git] based on the [contributing guide|https://github.com/jenkinsci/git-plugin/blob/master/CONTRIBUTING.adoc#contributing-to-the-git-plugin] # Identify the location in the code [GitSCM constructor|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/hudson/plugins/git/GitSCM.java] where Freestyle ("old style") jobs determine the browser is "no browser" and replace it with inference logic based on the repository URL # Investigate if the [GitStep|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/jenkins/plugins/git/GitStep.java] can be extended to infer the browser class from the repository URL as well # Define a [Jenkins extension point|https://jenkins.io/doc/developer/extensions/] for the browser inference logic

Add Comment

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite edited a comment on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

Thanks for your desire to contribute on this issue.  That is wonderful! I think you should take the following steps: # Assign the issue to yourself and change its state to "In Progress" so that others know you are working on it # Clone and compile the [git plugin|https://plugins.jenkins.io/git] based on the [contributing guide|https://github.com/jenkinsci/git-plugin/blob/master/CONTRIBUTING.adoc#contributing-to-the-git-plugin]

# Identify the location in the [GitSCM constructor|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/hudson/plugins/git/GitSCM.java] where Freestyle ("old style") jobs determine the browser is "no browser" and replace it with inference logic based on the repository URL

# Investigate if the [GitStep|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/jenkins/plugins/git/GitStep.java] can be extended to infer the browser class from the repository URL as well

# Define a [Jenkins extension point|https://jenkins.io/doc/developer/extensions/] for the browser inference logic inside the git plugin

Add Comment

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite edited a comment on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

Thanks for your desire to contribute on this issue.  That is wonderful! I think you should take the following steps: # Assign the issue to yourself and change its state to "In Progress" so that others know you are working on it # Clone and compile the [git plugin|https://plugins.jenkins.io/git] based on the [contributing guide|https://github.com/jenkinsci/git-plugin/blob/master/CONTRIBUTING.adoc#contributing-to-the-git-plugin]

# Use the [Jenkins git-plugin gitter channel|https://gitter.im/jenkinsci/git-plugin] for conversations as you progress in the implementation # Identify the location in the [GitSCM constructor|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/hudson/plugins/git/GitSCM.java] where Freestyle ("old style") jobs determine the browser is "no browser" and replace it with inference logic based on the repository URL

# Investigate if the [GitStep|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/jenkins/plugins/git/GitStep.java] can be extended to infer the browser class from the repository URL as well

# Define a [Jenkins extension point|https://jenkins.io/doc/developer/extensions/] for the browser inference logic inside the git plugin (see [Defining an extension point|https://wiki.jenkins.io/display/JENKINS/Defining+a+new+extension+point]) # Write automated tests to learn the code and to express what you've learned as code while making the changes

Add Comment

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite edited a comment on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

Thanks for your desire to contribute on this issue.  That is wonderful! I think you should take the following steps: # Assign the issue to yourself and change its state to "In Progress" so that others know you are working on it # Clone and compile the [git plugin|https://plugins.jenkins.io/git] based on the [contributing guide|https://github.com/jenkinsci/git-plugin/blob/master/CONTRIBUTING.adoc#contributing-to-the-git-plugin] # Use the [Jenkins git-plugin gitter channel|https://gitter.im/jenkinsci/git-plugin] for conversations as you progress in the implementation # Identify the location in the [GitSCM constructor|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/hudson/plugins/git/GitSCM.java] where Freestyle ("old style") jobs determine the browser is "no browser" and replace it with inference logic based on the repository URL

# Investigate if the [GitStep|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/jenkins/plugins/git/GitStep.java] can be extended to infer the browser class from the repository URL as well .  Do not be concerned if the GitStep is not readily modified or if changes to the GitStep are rejected. If is a legacy of the original pipeline implementation which has been superseded by the much more powerful checkout step

# Define a [Jenkins extension point|https://jenkins.io/doc/developer/extensions/] for the browser inference logic inside the git plugin (see [Defining an extension point|https://wiki.jenkins.io/display/JENKINS/Defining+a+new+extension+point]) # Write automated tests to learn the code and to express what you've learned as code while making the changes

Add Comment

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite edited a comment on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

Thanks for your desire to contribute on this issue.  That is wonderful! I think you should take the following steps: # Assign the issue to yourself and change its state to "In Progress" so that others know you are working on it # Clone and compile the [git plugin|https://plugins.jenkins.io/git] based on the [contributing guide|https://github.com/jenkinsci/git-plugin/blob/master/CONTRIBUTING.adoc#contributing-to-the-git-plugin] # Use the [Jenkins git-plugin gitter channel|https://gitter.im/jenkinsci/git-plugin] for conversations as you progress in the implementation # Identify the location in the [GitSCM constructor|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/hudson/plugins/git/GitSCM.java] where Freestyle ("old style") jobs determine the browser is "no browser" and replace it with inference logic based on the repository URL

# Investigate if the [GitStep|https://github.com/jenkinsci/git-plugin/blob/master/src/main/java/jenkins/plugins/git/GitStep.java] can be extended to infer the browser class from the repository URL as well.  Do not be concerned if the GitStep is not readily modified or if changes to the GitStep are rejected. If is a legacy of the original pipeline implementation which has been superseded by the much more powerful checkout step # Review [existing extension points|https://jenkins.io/doc/developer/extensions/git/] in the git plugin.  Likely best to model this one after [BuildChooser|https://javadoc.jenkins.io/plugin/git/hudson/plugins/git/util/BuildChooser.html] # # Define a [Jenkins extension point|https://jenkins.io/doc/developer/extensions/] for the browser inference logic inside the git plugin (see [Defining an extension point|https://wiki.jenkins.io/display/JENKINS/Defining+a+new+extension+point])

# Write automated tests to learn the code and to express what you've learned as code while making the changes

Add Comment

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite edited a comment on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

{color:red}colored text{color} Thanks for your desire to contribute on this issue.  That is wonderful!

# Define a [Jenkins extension point|https://jenkins.io/doc/developer/extensions/] for the browser inference logic inside the git plugin (see [Defining an extension point|https://wiki.jenkins.io/display/JENKINS/Defining+a+new+extension+point])

[mark.earl.waite@gmail.com (JIRA)]

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal assigned an issue to Gyanesha Prajjwal

Jenkins / JENKINS-48822

Make git plugin browser URL guessing clearer and easier to understand

Change By: Gyanesha Prajjwal Assignee: Gyanesha Prajjwal

Add Comment

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal started work on JENKINS-48822

Change By: Gyanesha Prajjwal Status: Open In Progress

Add Comment

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand What is browser URL here, is it same as web URL.

Add Comment

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

So, you mean I need to make certain changes, such that instead of "(Auto)" it should show the inferred browser repository in SCM.

Add Comment

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

Yes, I believe that will be one of the results of setting the browser in the constructor when the repository URL is a recognized URL. The constructor would continue to be called with the same arguments it has today. Inside the constructor, there would be a call to decide if the repository URL is a recognized URL. That call would be an extension point which is used by the git plugin to register the recognized URLs. Since it would be an extension point, other plugins could add their own recognized URLs without requiring changes to the git plugin. There is a page that describes how to define a new extension point. Refer to the current Jenkins extension points for possible reference implementations. The RepositoryBrowser is an extension point that is implemented in the git plugin repository browsers. I've never created a new extension point, so this will be a learning experience for me as well.

Add Comment

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

In GitSCM, there is a method guessBrowser() that is capable of inferring the repository browser. It has also been used in GitSCMBrowserTest. Can that be used for our purpose?

Add Comment

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal edited a comment on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

In GitSCM, there is a method guessBrowser() that is capable of inferring the repository browser (with the help of regex using the url ) . It has also been used in GitSCMBrowserTest.

Can that be used for our purpose?

Add Comment

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

The guessBrowser() method is adequate for the current implementation but would need to be extended to fit with the idea that was suggested by Stephen Connolly. The guessBrowser() method is not part of an extension point, so other plugins cannot register their own implementations. Thus, the Gitea plugin (today) is not allowed to provide its own repository browser implementation which would appear with other repository browser choices. The guessBrowser() implementation could iterate over the implementations of an extension point, asking each implementation if it would like to provide a repository browser for the current repository URL. The Jenkins concept of an extension point allows one plugin (Git plugin in this case) to provide a location which other plugins may implement to provide a repository browser.

Add Comment

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

What should be features of the extension point which will be created ( apart from inferring the browser ) ?

Add Comment

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal edited a comment on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

What should be features of the extension point which will be created ( apart from inferring the browser ) ?   Will it be like one of those in hudson.plugins.git.extensions.impl ?

Add Comment

[mark.earl.waite@gmail.com (JIRA)]

Mark Waite commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

I assume that the extension point would need a method that would be passed the repository URL and would either return an instance of GitRepositoryBrowser or null. The null return would mean that the extension rejected the request to provide a browser, while if the GitRepositoryBrowser was returned, then that would be the inferred browser. Word of warning: I'm inexperienced in this part of the Jenkins ecosystem, so we may need to discuss it with others that are more experienced. Francisco Fernández and rsandell do you have other guidance to offer?

Add Comment

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

Sorry, even I am new to this and I can't suggest anyone here. But I would love to contribute to this part of Jenkins.

Add Comment

[gyaneshaprajjwal@gmail.com (JIRA)]

Gyanesha Prajjwal commented on JENKINS-48822

Re: Make git plugin browser URL guessing clearer and easier to understand

Sir, I have made a pull request by adding only an extension point for inferring browser. I haven't made any additional changes. Kindly look into this and suggest the required changes and other steps which I need to take.

Add Comment