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

Support native Git for pipeline creation and editing

    Details

    • Sprint:
      Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4, Blue Ocean 1.2, Blue Ocean 1.3
    • Similar Issues:

      Description

      Improvement on roadmap

      This improvement is on the Blue Ocean project roadmap. Check the roadmap page for updates.

      Scope

      • User can click New Pipeline then pick Git and author a new Jenkinsfile using the Editor and save it back to the repository.
      • User can click Edit Pipeline then author the existing Jenkinsfile using the Editor and save their changes back to the repository
        • In a new branch
        • On the current branch

      Notes

      There are a number of security and user experience concerns that the team have to solve to get this working. 

       

      Design brief

      The user experience should match the equivalent Github feature as much as possible.
      The largest notable difference is that creating and editing with plain Git has noticeably more network traffic than Github. This means the user may have to wait for Blue Ocean to retrieve the content of the repository before showing them the Editor or before their save action is completed.

      Loading the editor

      • Developer clicks the edit action
      • Developer sees a progress dialog with a message "Loading your Jenkinsfile"
        • This could take a while as we have to do a shallow clone of the repository
        • How much progress information do we get from the clone? If we can easily get this info we can use a determinate progress indicator rather than a indeterminate one.
      • Developer should be able to cancel the load if it takes too long
      • Developer sees the Editor

      Saving from the editor

      1. Developer clicks save
      2. Developer sees the save dialog and then confirms
        • May commit back to new branch or current branch
      3. Developer sees progress dialog with message "Saving your pipeline"
      4. Developer lands back on the Activity screen

      Technical notes

      Unlike Github, Blue Ocean needs to make a shallow clone of the repository on the master in order to perform any operations. It is important to do whatever we can to make the editor work for developers at the best possible speed.

        Attachments

          Issue Links

            Activity

            michaelneale Michael Neale created issue -
            michaelneale Michael Neale made changes -
            Field Original Value New Value
            Epic Link JENKINS-36291 [ 172300 ]
            michaelneale Michael Neale made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            jamesdumay James Dumay made changes -
            Summary git load/save round tripping for editor Developer can load and save pipelines from the editor using native git
            jamesdumay James Dumay made changes -
            Issue Type Task [ 3 ] Story [ 10002 ]
            Description It would be nice to PoC (at least) a git load/save for round tripping. 

            This will help for wider support as well as proving out an SCM generic api 
            *Scope*
             * User can click New Pipeline then pick Git and author a new Jenkinsfile using the Editor and save it back to the repository.
             * User can click Edit Pipeline then author the existing Jenkinsfile using the Editor and save their changes back to the repository
             ** In a new branch
             ** On the current branch

            *Notes*

            There are a number of security and user experience concerns that the team have to solve to get this working. 

             

            *Design* *brief*
             The largest notable difference is that creating and editing with plain Git has noticeably more network traffic than Github. This means the user may have to wait for Blue Ocean to retrieve the content of the repository before showing them the Editor or before their save action is completed.

            +Loading the editor+
             * Developer clicks the edit action
             * Developer sees a progress dialog with a message "Loading your Jenkinsfile"
             ** This could take a while as we have to do a shallow clone of the repository
             ** How much progress information do we get from the clone? If we can easily get this info we can use a determinate progress indicator rather than a indeterminate one.
             * Developer should be able to cancel the load if it takes too long
             * Developer sees the Editor

            +Saving from the editor+
             # Developer clicks save
             # Developer sees the save dialog and then confirms
             ** May commit back to new branch or current branch
             # Developer sees progress dialog with message "Saving your pipeline"
             # Developer lands back on the Activity screen
            jamesdumay James Dumay made changes -
            Description *Scope*
             * User can click New Pipeline then pick Git and author a new Jenkinsfile using the Editor and save it back to the repository.
             * User can click Edit Pipeline then author the existing Jenkinsfile using the Editor and save their changes back to the repository
             ** In a new branch
             ** On the current branch

            *Notes*

            There are a number of security and user experience concerns that the team have to solve to get this working. 

             

            *Design* *brief*
             The largest notable difference is that creating and editing with plain Git has noticeably more network traffic than Github. This means the user may have to wait for Blue Ocean to retrieve the content of the repository before showing them the Editor or before their save action is completed.

            +Loading the editor+
             * Developer clicks the edit action
             * Developer sees a progress dialog with a message "Loading your Jenkinsfile"
             ** This could take a while as we have to do a shallow clone of the repository
             ** How much progress information do we get from the clone? If we can easily get this info we can use a determinate progress indicator rather than a indeterminate one.
             * Developer should be able to cancel the load if it takes too long
             * Developer sees the Editor

            +Saving from the editor+
             # Developer clicks save
             # Developer sees the save dialog and then confirms
             ** May commit back to new branch or current branch
             # Developer sees progress dialog with message "Saving your pipeline"
             # Developer lands back on the Activity screen
            *Scope*
             * User can click New Pipeline then pick Git and author a new Jenkinsfile using the Editor and save it back to the repository.
             * User can click Edit Pipeline then author the existing Jenkinsfile using the Editor and save their changes back to the repository
             ** In a new branch
             ** On the current branch

            *Notes*

            There are a number of security and user experience concerns that the team have to solve to get this working. 

             

            *Design* *brief*

            The user experience should match the equivalent Github feature as much as possible.
             The largest notable difference is that creating and editing with plain Git has noticeably more network traffic than Github. This means the user may have to wait for Blue Ocean to retrieve the content of the repository before showing them the Editor or before their save action is completed.

            +Loading the editor+
             * Developer clicks the edit action
             * Developer sees a progress dialog with a message "Loading your Jenkinsfile"
             ** This could take a while as we have to do a shallow clone of the repository
             ** How much progress information do we get from the clone? If we can easily get this info we can use a determinate progress indicator rather than a indeterminate one.
             * Developer should be able to cancel the load if it takes too long
             * Developer sees the Editor

            +Saving from the editor+
             # Developer clicks save
             # Developer sees the save dialog and then confirms
             ** May commit back to new branch or current branch
             # Developer sees progress dialog with message "Saving your pipeline"
             # Developer lands back on the Activity screen

            *Technical notes*

            Unlike Github, Blue Ocean needs to make a shallow clone of the repository on the master in order to perform any operations. It is important to do whatever we can to make the editor work for developers at the best possible speed.
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.0-rc4 [ 281 ] Blue Ocean 1.0-rc4, Blue Ocean - techdebt sprint 1 [ 281, 291 ]
            jamesdumay James Dumay made changes -
            Priority Major [ 3 ] Critical [ 2 ]
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.0-rc4, Blue Ocean - techdebt sprint 1 [ 281, 291 ] Blue Ocean 1.0-rc4, Blue Ocean 1.2 [ 281, 296 ]
            jamesdumay James Dumay made changes -
            Rank Ranked lower
            jamesdumay James Dumay made changes -
            Rank Ranked higher
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-43549 [ JENKINS-43549 ]
            jamesdumay James Dumay made changes -
            Remote Link This issue links to "Wiki Page (Jenkins Wiki)" [ 16221 ]
            jamesdumay James Dumay made changes -
            Remote Link This issue links to "how can i use Blue Ocean's Visual Pipeline Editor without github. I use gitlab. (Web Link)" [ 16232 ]
            jamesdumay James Dumay made changes -
            Remote Link This issue links to "Generate SSH keypair with Java (Web Link)" [ 16233 ]
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-43970 [ JENKINS-43970 ]
            jamesdumay James Dumay made changes -
            Rank Ranked higher
            jamesdumay James Dumay made changes -
            Summary Developer can load and save pipelines from the editor using native git Support native Git for pipeline creation and editing
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-44554 [ JENKINS-44554 ]
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.0-rc4, Blue Ocean 1.3 [ 281, 296 ] Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2 [ 281, 341 ]
            jamesdumay James Dumay made changes -
            Description *Scope*
             * User can click New Pipeline then pick Git and author a new Jenkinsfile using the Editor and save it back to the repository.
             * User can click Edit Pipeline then author the existing Jenkinsfile using the Editor and save their changes back to the repository
             ** In a new branch
             ** On the current branch

            *Notes*

            There are a number of security and user experience concerns that the team have to solve to get this working. 

             

            *Design* *brief*

            The user experience should match the equivalent Github feature as much as possible.
             The largest notable difference is that creating and editing with plain Git has noticeably more network traffic than Github. This means the user may have to wait for Blue Ocean to retrieve the content of the repository before showing them the Editor or before their save action is completed.

            +Loading the editor+
             * Developer clicks the edit action
             * Developer sees a progress dialog with a message "Loading your Jenkinsfile"
             ** This could take a while as we have to do a shallow clone of the repository
             ** How much progress information do we get from the clone? If we can easily get this info we can use a determinate progress indicator rather than a indeterminate one.
             * Developer should be able to cancel the load if it takes too long
             * Developer sees the Editor

            +Saving from the editor+
             # Developer clicks save
             # Developer sees the save dialog and then confirms
             ** May commit back to new branch or current branch
             # Developer sees progress dialog with message "Saving your pipeline"
             # Developer lands back on the Activity screen

            *Technical notes*

            Unlike Github, Blue Ocean needs to make a shallow clone of the repository on the master in order to perform any operations. It is important to do whatever we can to make the editor work for developers at the best possible speed.
            {panel:title=Improvement on roadmap|titleBGColor=#3878de|titleColor=white}
            This improvement is on the Blue Ocean project roadmap. Check the [roadmap page|https://jenkins.io/projects/blueocean/roadmap/] for updates.
            {panel}

            *Scope*
             * User can click New Pipeline then pick Git and author a new Jenkinsfile using the Editor and save it back to the repository.
             * User can click Edit Pipeline then author the existing Jenkinsfile using the Editor and save their changes back to the repository
             ** In a new branch
             ** On the current branch

            *Notes*

            There are a number of security and user experience concerns that the team have to solve to get this working. 

             

            *Design* *brief*

            The user experience should match the equivalent Github feature as much as possible.
             The largest notable difference is that creating and editing with plain Git has noticeably more network traffic than Github. This means the user may have to wait for Blue Ocean to retrieve the content of the repository before showing them the Editor or before their save action is completed.

            +Loading the editor+
             * Developer clicks the edit action
             * Developer sees a progress dialog with a message "Loading your Jenkinsfile"
             ** This could take a while as we have to do a shallow clone of the repository
             ** How much progress information do we get from the clone? If we can easily get this info we can use a determinate progress indicator rather than a indeterminate one.
             * Developer should be able to cancel the load if it takes too long
             * Developer sees the Editor

            +Saving from the editor+
             # Developer clicks save
             # Developer sees the save dialog and then confirms
             ** May commit back to new branch or current branch
             # Developer sees progress dialog with message "Saving your pipeline"
             # Developer lands back on the Activity screen

            *Technical notes*

            Unlike Github, Blue Ocean needs to make a shallow clone of the repository on the master in order to perform any operations. It is important to do whatever we can to make the editor work for developers at the best possible speed.
            jamesdumay James Dumay made changes -
            Status In Progress [ 3 ] Open [ 1 ]
            michaelneale Michael Neale made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            michaelneale Michael Neale made changes -
            Status In Progress [ 3 ] Open [ 1 ]
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2 [ 281, 341 ] Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3 [ 281, 341, 346 ]
            jamesdumay James Dumay made changes -
            Link This issue relates to JENKINS-45302 [ JENKINS-45302 ]
            jamesdumay James Dumay made changes -
            Remote Link This issue links to "Git creation and editing (Web Link)" [ 17261 ]
            jamesdumay James Dumay made changes -
            Link This issue relates to JENKINS-42791 [ JENKINS-42791 ]
            kzantow Keith Zantow made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            jamesdumay James Dumay made changes -
            Link This issue is duplicated by JENKINS-45681 [ JENKINS-45681 ]
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3 [ 281, 341, 346 ] Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4 [ 281, 341, 346, 361 ]
            jamesdumay James Dumay made changes -
            Assignee Keith Zantow [ kzantow ] Vivek Pandey [ vivek ]
            kzantow Keith Zantow made changes -
            Assignee Vivek Pandey [ vivek ] Keith Zantow [ kzantow ]
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4 [ 281, 341, 346, 361 ] Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4, Blue Ocean 1.2-beta5 [ 281, 341, 346, 361, 376 ]
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4, Blue Ocean 1.2 [ 281, 341, 346, 361, 376 ] Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4, Blue Ocean 1.2, Blue Ocean 1.3 - beta 1 [ 281, 341, 346, 361, 376, 386 ]
            kzantow Keith Zantow made changes -
            Remote Link This issue links to "PR 1299 (Web Link)" [ 17528 ]
            kzantow Keith Zantow made changes -
            Status In Progress [ 3 ] In Review [ 10005 ]
            cliffmeyers Cliff Meyers made changes -
            Link This issue is related to JENKINS-46434 [ JENKINS-46434 ]
            kzantow Keith Zantow made changes -
            Link This issue is duplicated by JENKINS-47137 [ JENKINS-47137 ]
            kzantow Keith Zantow made changes -
            Status In Review [ 10005 ] Resolved [ 5 ]
            Resolution Fixed [ 1 ]
            michaelneale Michael Neale made changes -
            Remote Link This issue links to "Page (Jenkins Wiki)" [ 17853 ]
            vivek Vivek Pandey made changes -
            Sprint Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4, Blue Ocean 1.2, Blue Ocean 1.3 [ 281, 341, 346, 361, 376, 386 ] Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4, Blue Ocean 1.2, Blue Ocean 1.3, Blue Ocean 1.5 - beta 3 [ 281, 341, 346, 361, 376, 386, 491 ]
            jamesdumay James Dumay made changes -
            Sprint Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4, Blue Ocean 1.2, Blue Ocean 1.3, Blue Ocean 1.5 - beta 3 [ 281, 341, 346, 361, 376, 386, 491 ] Blue Ocean 1.0-rc4, Blue Ocean 1.2-beta2, Blue Ocean 1.2-beta3, Blue Ocean 1.2-beta4, Blue Ocean 1.2, Blue Ocean 1.3 [ 281, 341, 346, 361, 376, 386 ]

              People

              • Assignee:
                kzantow Keith Zantow
                Reporter:
                michaelneale Michael Neale
              • Votes:
                42 Vote for this issue
                Watchers:
                49 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: