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

github-org folder is incompatible with git flow implementations - branch names break builds

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      There are two serious problems with the current implementation of github-organizational plugin and both of them are related to branch names.

      Git flow uses branch names like `feature/xxx` or `release/1.0.0` which are translated by Jenkins into into `%2F` by using HTTP escaping. Still, this causes breaks python virtualenv seriously because if the build job is trying to create a virtual environment inside a path that contains percent, it will create a virtualenvironment than works in 50/50, based on luck (we tested with more than 10 top Python packages and at least half of them fail to build or install due to the presence of the percent sign inside the python PATH).

      Second problem is the final length of the PATH becomes too long for many build jobs and they start to fail. We found references online that only lengths of branch names up to 16-20 characters are supposed to be safe, others will probably break builds.

      To understand the extent of this issue have a look at this PATH:

      /var/lib/jenkins/jobs/apache-org/jobs/apache-project-aaa-api/branches/feature%2Fimplement-a-cool-error-page/workspace
      

      Some would argue that the team can decide to introduce a policy for branch names, one that would not use the slash and that would require limited length. Sadly, slash is the default separator used by all the git GUI tools for grouping branches into directories (collapsing). Also, there is no way to enforce a naming convention and branch renaming is a very complex problem, is not just a one click away.

      Due to this, I think that it would be the best to deal with these issues inside the github organization plugin. Some of my colleagues proposed the use of a sha1 sum on branch name, but I am not a big fun of this because is very cryptic – if you do an ls in the branches directory, you will not be able to figure out which one is safe to remove or not.

        Attachments

          Issue Links

            Activity

            Hide
            michaelneale Michael Neale added a comment -

            I have been bitten by this too, only not with python virtualenv, but "npm run" scripts. Same issue (it seems tripped up by the %).

            Technically % is reserved: https://en.wikipedia.org/wiki/Filename

            It is hard to think up an alternative scheme, as people could put anything in branch names right?
            Note these branch names are used both in uri's in Jenkins as well as file paths:

            Possibility:
            feature/TEST-123 > /var/lib/jenkins/jobs/apache-org/jobs/apache-project-aaa-api/branches/feature__TEST-123

            if it was "special case" for "/" could work, but as other things could appear in branch names, what is the generic encoding to be used for filenames? (as these end up on disk).

            The rules for branch names:
            http://stackoverflow.com/questions/3651860/which-characters-are-illegal-within-a-branch-name

            so some kind of encoding is needed, but perhaps something as generic as URL encoding is overkill, and we can have something that works for both URIs and file systems. As long as it looks reasonable when looking at the URI and also the filesystem that would be nice, but it seems a shame this has to come to this because of poor tooling.

            Show
            michaelneale Michael Neale added a comment - I have been bitten by this too, only not with python virtualenv, but "npm run" scripts. Same issue (it seems tripped up by the %). Technically % is reserved: https://en.wikipedia.org/wiki/Filename It is hard to think up an alternative scheme, as people could put anything in branch names right? Note these branch names are used both in uri's in Jenkins as well as file paths: Possibility: feature/TEST-123 > /var/lib/jenkins/jobs/apache-org/jobs/apache-project-aaa-api/branches/feature_ _TEST-123 if it was "special case" for "/" could work, but as other things could appear in branch names, what is the generic encoding to be used for filenames? (as these end up on disk). The rules for branch names: http://stackoverflow.com/questions/3651860/which-characters-are-illegal-within-a-branch-name so some kind of encoding is needed, but perhaps something as generic as URL encoding is overkill, and we can have something that works for both URIs and file systems. As long as it looks reasonable when looking at the URI and also the filesystem that would be nice, but it seems a shame this has to come to this because of poor tooling.

              People

              Assignee:
              kohsuke Kohsuke Kawaguchi
              Reporter:
              ssbarnea Sorin Sbarnea
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: