package Ġk y ge . actions Ċ Ċ import Ġk y ge .* Ċ import Ġk y ge . builder Ċ Ċ object Ġcheckout Ġ{ ĊĊĠĠĠ Ġval Ġv 2 : ĠV 2 ĊĠĠĠĠĠĠĠ Ġget () Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġbullet Point Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" uses : Ġactions /${ V 2 . action Name Version ed }" ĊĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĠĠĠĠĠĠĠĠĠĠĠ Ġreturn ĠV 2 ĊĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠ Ġobject ĠV 2 Ġ: ĠStep (), ĠAction < V 2 . Builder > Ġ{ ĊĊĠĠĠĠĠĠĠ Ġoverride Ġval Ġaction Name Ġ= Ġ" checkout " ĊĠĠĠĠĠĠĠ Ġoverride Ġval Ġaction Version Ġ= Ġ" v 2 " ĊĠĠĠĠĠĠĠ Ġoverride Ġval Ġt Ġ= ĠBuilder () ĊĊĠĠĠĠĠĠĠ Ġclass ĠBuilder Ġ{ ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠRepository Ġname Ġwith Ġowner . ĠFor Ġexample , Ġactions / checkout ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠDefault : Ġgithub . repository Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġrepository : ĠString ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" repository : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠThe Ġbranch , Ġtag Ġor ĠSHA Ġto Ġcheckout . ĠWhen Ġchecking Ġout Ġthe Ġrepository Ġthat Ġtriggered Ġa Ġworkflow , Ġthis ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ Ġdefaults Ġto Ġthe Ġreference Ġor ĠSHA Ġfor Ġthat Ġevent . ĠOtherwise , Ġuses Ġthe Ġdefault Ġbranch . Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġref : ĠString ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" ref : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠPersonal Ġaccess Ġtoken Ġ( PAT ) Ġused Ġto Ġfetch Ġthe Ġrepository . ĠThe ĠPAT Ġis Ġconfigured Ġwith Ġthe Ġlocal Ġgit ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ Ġconfig , Ġwhich Ġenables Ġyour Ġscripts Ġto Ġrun Ġauthenticated Ġgit Ġcommands . ĠThe Ġpost - job Ġstep Ġremoves Ġthe ĠPAT . ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠWe Ġrecommend Ġusing Ġa Ġservice Ġaccount Ġwith Ġthe Ġleast Ġpermissions Ġnecessary . ĠAlso Ġwhen Ġgenerating Ġa Ġnew ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠPAT , Ġselect Ġthe Ġleast Ġscopes Ġnecessary . ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ Ġ[ Learn Ġmore Ġabout Ġcreating Ġand Ġusing Ġencrypted Ġsecrets ]( https :// help . github . com / en / actions / autom ating - your - workflow - with - github - actions / creating - and - using - encrypted - secrets ) ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠDefault : Ġgithub . token Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġtoken : ĠString ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" token : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠSSH Ġkey Ġused Ġto Ġfetch Ġthe Ġrepository . ĠThe ĠSSH Ġkey Ġis Ġconfigured Ġwith Ġthe Ġlocal Ġgit Ġconfig , Ġwhich Ġenables ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ Ġyour Ġscripts Ġto Ġrun Ġauthenticated Ġgit Ġcommands . ĠThe Ġpost - job Ġstep Ġremoves Ġthe ĠSSH Ġkey . ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠWe Ġrecommend Ġusing Ġa Ġservice Ġaccount Ġwith Ġthe Ġleast Ġpermissions Ġnecessary . ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ Ġ[ Learn Ġmore Ġabout Ġcreating Ġand Ġusing Ġencrypted Ġsecrets ]( https :// help . github . com / en / actions / autom ating - your - workflow - with - github - actions / creating - and - using - encrypted - secrets ) Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġssh Key : ĠString ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" ssh - key : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠKnown Ġhosts Ġin Ġaddition Ġto Ġthe Ġuser Ġand Ġglobal Ġhost Ġkey Ġdatabase . ĠThe Ġpublic ĠSSH Ġkeys Ġfor Ġa Ġhost Ġmay Ġbe ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ Ġobtained Ġusing Ġthe Ġutility Ġ` ssh - key scan `. ĠFor Ġexample , Ġ` ssh - key scan Ġgithub . com `. ĠThe Ġpublic Ġkey Ġfor ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ Ġgithub . com Ġis Ġalways Ġimplicitly Ġadded . Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġssh Known Hosts : ĠString ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" ssh - known - hosts : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠWhether Ġto Ġperform Ġstrict Ġhost Ġkey Ġchecking . ĠWhen Ġtrue , Ġadds Ġthe Ġoptions Ġ` Strict Host Key Checking = yes ` Ġand ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ Ġ` Check Host IP = no ` Ġto Ġthe ĠSSH Ġcommand Ġline . ĠUse Ġthe Ġinput Ġ` ssh - known - hosts ` Ġto Ġconfigure Ġadditional Ġhosts . ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠDefault : Ġtrue Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġssh Strict : ĠBoolean ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" ssh - strict : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠWhether Ġto Ġconfigure Ġthe Ġtoken Ġor ĠSSH Ġkey Ġwith Ġthe Ġlocal Ġgit Ġconfig ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠDefault : Ġtrue Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġpersist Credentials : ĠString ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" persist - credentials : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠRelative Ġpath Ġunder Ġ$ GITHUB _ WORK SPACE Ġto Ġplace Ġthe Ġrepository Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġpath : ĠString ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" path : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠWhether Ġto Ġexecute Ġ` git Ġclean Ġ- ff dx Ġ&& Ġgit Ġreset Ġ-- hard ĠHEAD ` Ġbefore Ġfetching ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠDefault : Ġtrue Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġclean : ĠBoolean ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" clean : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠNumber Ġof Ġcommits Ġto Ġfetch . Ġ 0 Ġindicates Ġall Ġhistory Ġfor Ġall Ġbranches Ġand Ġtags . ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠDefault : Ġ 1 Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġfetch Depth : ĠInt ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" fetch - depth : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** Ġ[ Ky ge ] Ġcustom Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġval Ġfetch All : ĠUnit ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġget () Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġfetch Depth Ġ= Ġ 0 ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠWhether Ġto Ġdownload ĠGit - L FS Ġfiles ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠDefault : Ġfalse Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġl fs : ĠBoolean ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" lfs : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĊĠĠĠĠĠĠĠĠĠĠĠ Ġ/** ĠWhether Ġto Ġcheckout Ġsub modules : Ġ` true ` Ġto Ġcheckout Ġsub modules Ġor Ġ` recursive ` Ġto Ġrecursively Ġcheckout ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ Ġsub modules . ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠWhen Ġthe Ġ` ssh - key ` Ġinput Ġis Ġnot Ġprovided , ĠSSH ĠURLs Ġbeginning Ġwith Ġ` git @ github . com :` Ġare Ġconverted Ġto ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠHTTPS . ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* ĊĠĠĠĠĠĠĠĠĠĠĠĠ Ġ* Ġ ĠDefault : Ġfalse Ġ*/ ĊĠĠĠĠĠĠĠĠĠĠĠ Ġvar Ġsub modules : ĠBoolean ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ@ Deprecated ( message Ġ= Ġ" Write Ġonly Ġproperty ", Ġlevel Ġ= ĠDeprec ation Level . HIDDEN ) Ġget () Ġ= Ġerror ("") ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġset ( value ) Ġ{ ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġbuilder Ġ+= Ġ" sub modules : Ġ$ value " ĊĠĠĠĠĠĠĠĠĠĠĠĠĠĠĠ Ġ} ĊĠĠĠĠĠĠĠ Ġ} ĊĠĠĠ Ġ} Ċ }