Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-33228

GitHub server configuration undocumented / duplicated

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      If I install this plugin, and attempt to use it with a GitHub Enterprise server (via New Item > Multibranch pipeline > Branch Sources > GitHub), there isn't any documentation.

      I discovered that there is a "API endpoint" dropdown, but it just says "GitHub" and has no documentation.

      If I go to Manage Jenkins > Manage System, I see two different places to configure GitHub servers — one comes from the GitHub plugin, which is a dependency. This is directly followed by a duplicate, but less-detailed configuration UI, provided by this plugin.

      Ideally, there should be one single, documented place to enter the required information.

        Attachments

          Issue Links

          is duplicated by

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-39025 Pull request from forks are not build

          • Major - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-46366 REGRESSION: Github branch source does not consistently set up webhook

          • Major - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-42992 Webhooks don't work from GitHub Enterprise when using Multi-Branch Pipeline jobs

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-37845 GitHub plugin build-on-push for Pipeline job is hard/unpredictable to work with

          • Major - Major loss of function.
          • Resolved
          is related to

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-33318 GitHub Enterprise Server validation does not work when private mode is enabled

          • Major - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-41633 UX: non-obvious that API tokens need to be stored as UsernamePassword to work as scan credentials

          • Major - Major loss of function.
          • Open
          links to

          Web Link CloudBees Internal CD-171

          Web Link GH PR-181

          Web Link GHBS PR-164

          Web Link PR-1

          Web Link PR-2

            Activity

            Descending order - Click to sort in ascending order
            Hide
            Permalink
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Merkushev Kirill
            Path:
            src/main/java/org/jenkinsci/plugins/github/config/GitHubPluginConfig.java
            src/main/java/org/jenkinsci/plugins/github/config/GitHubServerConfig.java
            src/main/java/org/jenkinsci/plugins/github/migration/Migrator.java
            src/main/resources/org/jenkinsci/plugins/github/config/GitHubPluginConfig/config.groovy
            src/main/resources/org/jenkinsci/plugins/github/config/GitHubServerConfig/config.groovy
            src/main/resources/org/jenkinsci/plugins/github/config/GitHubServerConfig/help-apiUrl.html
            src/main/resources/org/jenkinsci/plugins/github/config/GitHubServerConfig/help-clientCacheSize.html
            src/main/resources/org/jenkinsci/plugins/github/config/GitHubServerConfig/help-customApiUrl.html
            src/test/java/org/jenkinsci/plugins/github/config/GitHubServerConfigTest.java
            src/test/java/org/jenkinsci/plugins/github/internal/GitHubClientCacheCleanupTest.java
            src/test/java/org/jenkinsci/plugins/github/internal/GitHubClientCacheOpsTest.java
            src/test/java/org/jenkinsci/plugins/github/test/GHMockRule.java
            http://jenkins-ci.org/commit/github-plugin/44a87816b187bd21a32e7942f3830ca3f6fbfa45
            Log:
            Merge pull request #112 from jenkinsci/config-improvements

            JENKINS-33228 Misc global config page improvements

            Compare: https://github.com/jenkinsci/github-plugin/compare/20c159e05809...44a87816b187

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Merkushev Kirill Path: src/main/java/org/jenkinsci/plugins/github/config/GitHubPluginConfig.java src/main/java/org/jenkinsci/plugins/github/config/GitHubServerConfig.java src/main/java/org/jenkinsci/plugins/github/migration/Migrator.java src/main/resources/org/jenkinsci/plugins/github/config/GitHubPluginConfig/config.groovy src/main/resources/org/jenkinsci/plugins/github/config/GitHubServerConfig/config.groovy src/main/resources/org/jenkinsci/plugins/github/config/GitHubServerConfig/help-apiUrl.html src/main/resources/org/jenkinsci/plugins/github/config/GitHubServerConfig/help-clientCacheSize.html src/main/resources/org/jenkinsci/plugins/github/config/GitHubServerConfig/help-customApiUrl.html src/test/java/org/jenkinsci/plugins/github/config/GitHubServerConfigTest.java src/test/java/org/jenkinsci/plugins/github/internal/GitHubClientCacheCleanupTest.java src/test/java/org/jenkinsci/plugins/github/internal/GitHubClientCacheOpsTest.java src/test/java/org/jenkinsci/plugins/github/test/GHMockRule.java http://jenkins-ci.org/commit/github-plugin/44a87816b187bd21a32e7942f3830ca3f6fbfa45 Log: Merge pull request #112 from jenkinsci/config-improvements JENKINS-33228 Misc global config page improvements Compare: https://github.com/jenkinsci/github-plugin/compare/20c159e05809...44a87816b187
            Hide
            Permalink
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Kohsuke Kawaguchi
            Path:
            src/main/java/org/jenkinsci/plugins/github/config/GitHubPluginConfig.java
            http://jenkins-ci.org/commit/github-plugin/dc3319946ca0dfbe2609ba359b72452a18bb31ed
            Log:
            Nobody cares what plugin is being configured!

            ... especially so if this plugin is meant to be a common configuration point for all GitHub related plugins, ala JENKINS-33228.

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Kohsuke Kawaguchi Path: src/main/java/org/jenkinsci/plugins/github/config/GitHubPluginConfig.java http://jenkins-ci.org/commit/github-plugin/dc3319946ca0dfbe2609ba359b72452a18bb31ed Log: Nobody cares what plugin is being configured! ... especially so if this plugin is meant to be a common configuration point for all GitHub related plugins, ala JENKINS-33228 .
            Hide
            Permalink
            kohsuke Kohsuke Kawaguchi added a comment -

            This "GitHub Enterprise Server" configuration appears to be necessary only because the API endpoint configuration is a drop-down instead of textbox.

            I think an easy fix is just to turn it into the textbox and remove the global configuration. A textbox can have auto-completion configured to pick up API endpoint values from github plugin and other organization folders.

            For GitHub plugin configuration to become reusable for other plugins, it needs some work, too...

            Show
            kohsuke Kohsuke Kawaguchi added a comment - This "GitHub Enterprise Server" configuration appears to be necessary only because the API endpoint configuration is a drop-down instead of textbox. I think an easy fix is just to turn it into the textbox and remove the global configuration. A textbox can have auto-completion configured to pick up API endpoint values from github plugin and other organization folders. For GitHub plugin configuration to become reusable for other plugins, it needs some work, too...
            Hide
            Permalink
            hrmpw Patrick Wolf added a comment -

            I agree with Jesse Glick. We should use the existing APIs here to simplify the user experience. Even if we remove the dependency on the github-plugin there are many installations that already include this plugin. That doesn't really solve the problem.

            Show
            hrmpw Patrick Wolf added a comment - I agree with Jesse Glick . We should use the existing APIs here to simplify the user experience. Even if we remove the dependency on the github-plugin there are many installations that already include this plugin. That doesn't really solve the problem.
            Hide
            Permalink
            recena Manuel Recena Soto added a comment -

            I've updated the Issue Links section with information that it will help to improve a bit this issue. I'm working on JENKINS-33318.

            Show
            recena Manuel Recena Soto added a comment - I've updated the Issue Links section with information that it will help to improve a bit this issue. I'm working on JENKINS-33318 .
            6 older comments

              People

              Assignee:
              cloudbees CloudBees Inc.
              Reporter:
              orrc Christopher Orr
              Votes:
              1 Vote for this issue
              Watchers:
              10 Start watching this issue

                Dates

                Created:
                Updated: