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

Naming inconsistency between GitHub and Bitbucket

XMLWordPrintable

    • 43.vea_da_7c53b_831

      Hello,

      I'd like to enhance the docs of this plugin and create a PR for that.

      However, I've realized that there is a naming inconsistency between GitHub and Bitbucket which is super confusing.

      Not sure if that intended or there are any constraints that force that naming inconsistency.

      Thanks

          [JENKINS-64360] Naming inconsistency between GitHub and Bitbucket

          Jack Whelpton added a comment - - edited

          I think the naming has to be different to avoid clashes (see, e.g. https://issues.jenkins.io/browse/JENKINS-61464). That said, it feels like clearer naming might be:

          skipBitbucketNotifications
          skipGitHubNotifications
          skipGitLabNotifications

          etc. It's more verbose, but seems more consistent and extensible than the current approach.

          Jack Whelpton added a comment - - edited I think the naming has to be different to avoid clashes (see, e.g. https://issues.jenkins.io/browse/JENKINS-61464 ). That said, it feels like clearer naming might be: skipBitbucketNotifications skipGitHubNotifications skipGitLabNotifications etc. It's more verbose, but seems more consistent and extensible than the current approach.

          Ahmed AbouZaid added a comment -

          jackwhelpton I really like your suggestion

           

          Ahmed AbouZaid added a comment - jackwhelpton I really like your suggestion  

          Valentin Delaye added a comment - - edited

          Hi,

          In gitlab plugin the symbol is named 'gitlabSkipNotifications' : https://github.com/jenkinsci/gitlab-branch-source-plugin/pull/79

          I'm planning to rename the symbols (and classes)

          bitbucketSkipNotifications
          githubSkipNotifications

          Regards,

          Valentin Delaye added a comment - - edited Hi, In gitlab plugin the symbol is named 'gitlabSkipNotifications' : https://github.com/jenkinsci/gitlab-branch-source-plugin/pull/79 I'm planning to rename the symbols (and classes) bitbucketSkipNotifications githubSkipNotifications Regards,

          Ahmed AbouZaid added a comment - - edited

          jonesbusy Thanks for taking care of this

          I'd suggest also keeping the old names with a deprecation note for backward compatibility.

          Ahmed AbouZaid added a comment - - edited jonesbusy Thanks for taking care of this I'd suggest also keeping the old names with a deprecation note for backward compatibility.

            jonesbusy Valentin Delaye
            aabouzaid Ahmed AbouZaid
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: