[JIRA] (JENKINS-57539) Prepare design document for a top level architecture

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda created an issue

Jenkins / JENKINS-57539 Prepare design document for a top level architecture Issue Type: Story Assignee: Mark Waite Components: branch-api-plugin, git-plugin, gitlab-api-plugin, gitlab-branch-source-plugin, gitlab-plugin, pipeline-multibranch-defaults-plugin, scm-api-plugin Created: 2019-05-18 10:57 Environment: Google Docs Labels: gsoc-2019 Priority: Minor Reporter: Parichay Barpanda This issue is about preparing a design document of a top level architecture for the plugins that will be developed in the 'Multibranch Pipeline Support for GitLab' Project. Objectives and expectations based on proposal Answer questions such as "How is the user going to use this?", "What configurations are needed?",  "What are the components of the plugin?" Create diagrams of API Write mini user guides as if project is already done After completion, reality mapping shall be done by a discussion with the key stakeholders in other Branch Source Plugins.   Add Comment

This message was sent by Atlassian Jira (v7.11.2#711002-sha1:fdc329d)

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda updated an issue

Jenkins / JENKINS-57539 Prepare design document for a top level architecture

Change By: Parichay Barpanda Priority: Minor Major

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda updated an issue

Jenkins / JENKINS-57539 Prepare design document for a top level architecture Change By: Parichay Barpanda

This issue is about preparing a design document of a top level architecture for the plugins that will be developed in the 'Multibranch Pipeline Support for GitLab' Project.

* Objectives and expectations based on proposal * Answer questions such as ** "How is the user going to use this?", ** "What configurations are needed?",  ** "What are the components of the plugin?" * Create diagrams of API * Write mini user guides as if project is already done

After completion, reality mapping shall be done by a discussion with the key stakeholders in other Branch Source Plugins.

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda assigned an issue to Parichay Barpanda

Jenkins / JENKINS-57539 Prepare design document for a top level architecture

Change By: Parichay Barpanda Assignee: Mark Waite Parichay Barpanda

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda updated an issue

Jenkins / JENKINS-57539 Prepare design document for a top level architecture

Change By: Parichay Barpanda Sprint: GSoC 2019. Coding Phase 3 1

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda updated an issue

Jenkins / JENKINS-57539 Prepare design document for a top level architecture

Change By: Parichay Barpanda Sprint: GSoC 2019. Coding Phase 1 3

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda updated an issue

Jenkins / JENKINS-57539 Prepare design document for a top level architecture

Change By: Parichay Barpanda Sprint: GSoC 2019. Coding Phase 1 Community Bonding

Add Comment

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

Mark Waite commented on JENKINS-57539

Re: Prepare design document for a top level architecture There are several good documents available that can be used as the starting point, including: Branch API Implementation Guide Branch API User Guide SCM API Implementation Guide SCM API Consumer Guide Branches and Pull Requests in the Jenkins User Handbook Practical Guide to CI with Jenkins and GitHub - GitHub White Paper Pipeline Fundamentals course from CloudBees (with large sections on multibranch Pipelines and their use)

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda commented on JENKINS-57539

Re: Prepare design document for a top level architecture

Thanks Mark. I was already referring to the SCM API and BRANCH API docs. They are verbose and gives a nice picture of how the implementation will be done. I'll check rest of the pointers for more info.

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda updated an issue

Jenkins / JENKINS-57539

Prepare design document for a top level architecture

Change By: Parichay Barpanda

This issue is about preparing a design document of a top level architecture for the plugins that will be developed in the 'Multibranch Pipeline Support for GitLab' Project. * Objectives and expectations based on proposal * Answer questions such as ** "How is the user going to use this?", ** "What configurations are needed?",  ** "What are the components of the plugin?" * Create diagrams of API * Write mini user guides as if project is already done

After completion, reality mapping shall be done by through a discussion with the key stakeholders in other Branch Source Plugins.

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda started work on JENKINS-57539

Change By: Parichay Barpanda Status: Open In Progress

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda commented on JENKINS-57539

Re: Prepare design document for a top level architecture The document is being created as the implementation are done.

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda updated JENKINS-57539

Some important implementation of classes has been added to the document from the SCM API and Branch API docs. Unfortunately couldn't find more support for design document from any experienced developer of any Branch Source Plugin but with the help of well maintained codebase and javadocs I was able to come up with my versions of implementations idea. The design document doesn't provide a concrete idea of our plugin APIs but it will be updated throughout the course of development. So at the end of the plugin release, this design document will contain all the necessary information a user or other plugin authors require to extend or get inspired.

Jenkins / JENKINS-57539

Prepare design document for a top level architecture

Change By: Parichay Barpanda Status: In Progress Fixed but Unreleased Resolution: Fixed

Add Comment

[parichay.barpanda@gmail.com (JIRA)]

Parichay Barpanda updated an issue

Jenkins / JENKINS-57539 Prepare design document for a top level architecture

Change By: Parichay Barpanda Comment:

The document is being created as the implementation are done.

Add Comment

[marky.r.jackson@gmail.com (JIRA)]

Marky Jackson commented on JENKINS-57539

Re: Prepare design document for a top level architecture Per team agreeable, this document is meeting acceptance. Parichay Barpanda says he would like to add a few more items to this body of work. I will leave open until then but it is agreed that this can be closed once that is done.

Add Comment

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

Mark Waite updated an issue

Jenkins / JENKINS-57539

Prepare design document for a top level architecture

Change By: Mark Waite Component/s: git-plugin

Add Comment

This message was sent by Atlassian Jira (v7.13.12#713012-sha1:6e07c38)