Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Note - branch/version is a bit blurry, but we can think of version as another 'main' branch that is being actively worked on. ex: epics 3 vs 7, both 3 and 7 are actively getting fixes.

Create Issue:

Code Block
'headers': {
 	"linux_username": "string",
	"gitub_username": "string" 
},
'body': {
	"caterNumber": "string"
	"component": "string"
	"issueTracker": "string", // OPTIONAL
}

Add new version for active development on component:

Code Block
'headers': {
 	"linux_username": "string",
	"gitub_username": "string" 
}

Add new version for active development on component:

Code Block
,
'body': {
	"component": "string"
	"version": "string"
}

Create new branch

Code Block
'headers': {
 	"linux_username": "string",
	"gitub_username": "string" 
}

Create new branch

Code Block
,
'body': {
	"component": "string"
	"version": "string"
	"type": "string"		// ex: [fix, dev] where fix is meant to merge to main, and dev is not
	"branchPoint": "string" // where to start the branch from: [branch, tag, commit]
}

Checkout component

Code Block
'headers': {
 	"linux_username": "string",
	"gitub_username": "string" 
}

Checkout component

Code Block
,
'body': {
	"component": "string"
	"branch": "string"
 	"linux_username": "string",
	"gitub_username": "string"
}

Push 

Code Block
// Any reason we can't use git directly?

Mark complete (use when a dev is done, to notify backend the development is considered done)

Code Block
'headers': {
 	"componentlinux_username": "string",
	"branchgitub_username": "string" 
},
'body': {
	"linux_usernamecomponent": "string",
	"gitub_usernamebranch": "string"
}

Start Build (called by runner / cli)

Code Block
'headers': {
  	"componentlinux_username": "string",
	"branchgitub_username": "string"   
	"linux_username
},
'body': {
  	"component": "string",
	"gitub_usernamebranch": "string"   
}