From dc659980cd06661e39f2e18f9a94bec90b80d3c5 Mon Sep 17 00:00:00 2001 From: Andy McKay Date: Wed, 8 Jul 2020 14:50:49 -0700 Subject: [PATCH] update the readme a bit --- README.md | 24 +++++++++++++++++++----- docs/arrow.png | Bin 0 -> 4914 bytes 2 files changed, 19 insertions(+), 5 deletions(-) create mode 100644 docs/arrow.png diff --git a/README.md b/README.md index 7b79009..c54e4f7 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,24 @@ -# actions-sync +# Actions Sync -Sync GitHub Action repositories from https://www.github.com to your GHES instance. +

+ +

-## Non air-gapped GHES instances +Sync GitHub Action repositories from to your GHES instance. -When there are machines which have access to both the public interenet and the the GHES instance run `actions-sync sync`. +This tool is a standalone Go tool to allow you to sync from [GitHub](https://www.github.com) to a [GitHub Enterprise instance](https://github.com/enterprise). Referred to as `GHES` throughout this readme. + +* Current status: **ready for production use** +* Download from: [releases page](https://github.com/actions/actions-sync/releases/) +* Build status: ![Actions Sync Status](https://github.com/actions/actions-sync/workflows/CI/badge.svg) + +It is designed to work when: +* The GitHub Enterprise instance is seperate from the rest of the internet. +* The GitHub Enterprise instance is connected to the rest of the internet. + +## Connected instances + +When there are machines which have access to both the public internet and the the GHES instance run `actions-sync sync`. **Command:** @@ -35,7 +49,7 @@ When there are machines which have access to both the public interenet and the t --repo-name actions/setup-node ``` -## Air-gapped GHES instances +## Not connected instances When no machine has access to both the public internet and the GHES instance: diff --git a/docs/arrow.png b/docs/arrow.png new file mode 100644 index 0000000000000000000000000000000000000000..4244ba9d08ef3b52719db2454c84fec35bcda48b GIT binary patch literal 4914 zcmeHLhhG!hwoXC}5C~uZ1w;&iLpKSbW9XnDy(lOm2_zILL3-!VQOcng=_)9wARR+7 zh|-IQ90a5vib#b95#F03u1YcsyK3LZpL0z~ei5 z#YLg+J|;0SaVGeXS5%gWSIltc#yg#FP9y+<%BsIGV|X|N8``K0_tBrjdb-&C9@Q*_ zIz7J|vT=|bJ-OCy_8X|)#3VK)bn6_#zz`)OMhmJ3tW4|Hg{m&IAS@p;EQ%lkSYmQn z2xLG-3SwCRFT=0ar@9S8SRxbzPC7tlnGlx3j5@fpcVIQA!M;HsIn{&I!+2YjtZp#Y zXAq5&uN#Bz=Wa5I#bO7gE_3jP7N(X?Wo0~l^Z-x96RA`H)FWo8Uye%X6ln`(6KAu< zKhFem1jew%(tjs3@Y2zRoKx3>Em{N7kf`uIC_ENE&4S-=Gs&@Y1`|BU_IP~m_R-OT z8wBF54~cp?d~|fwbZ~U^vYU%5lPrnh-Gu;z?+_lMC4tj4UTsJgI(GW{05O`(0005u z06Llkr0sxcM*#ST3;+nxS^$79ISN2eYvHuRr~vd&E0DW@?w>Ni>)27vR6|FH)|%S7 zlSr-}4rEXLlLCPN07%Kv%)-+`Ur*7N?1CZ?$u=aEuZ!C;1c38Zq=_yhPXfZ%#o5(E z(N_ui!$XlKAFI(w#19uwCncnXz7ax$>`p?+prlb4q%stNK;Yboc8VsN7ypFQu9T1t zo}O-sXta-y56VXhMRvDGODZTRpfOl97JHuNao)qv)sx_R-ql0kXOMr!(Ik1;x;wgg zI+9%x$8iZZWG_!8B=R`XzqX(KB>6i2mC4oP&$4I*qK_?TNfZYCpJ1MjcK-+L*zyzh zqpqLnaL2(EuXvE$HOMY5Bv()6zsSY?$n-yqfA#Yx(8$r3`z5j7geTm zF1bcndE2*5?o23MuwU(2W*K?mv8ohk2-@lEX`^_pmI&6+GEos*a|;quk>MJ*8SpjbH)qYT&G5=?aj7x zMdMUP8n^Y_4hK{}RmgqJPg~%-m9+i)dbjTkKX6n-@r+CbGMxOx{$_tS)y??Scydy& zxO?U9@5}Xx)G4>#e%6J#t#++XIcZ55!_^%&P3fH~pz7$YT1TW71hnzhIvxz#{1~p_ zcUbr_B7$FfY@&}|y~_Te`ZoW)FG9hYJT&L`(pQG)^@$kU2i{3jEgwL1{C@LajpI90 zDLTa$*$Tgok`#|7@B7O>n0Mh*;#UpO_R$bBAWofH8|GrBXt#xrth+9jAY`lj7qq8p zrp9^=`knM3>-Tckkn%S~HMeVUhOD$o{6|ZFPZ2UAs)wpFw>=Ck{K7l|jR4<-y@o&> z;9$W-A?RF7gzEEX$f&Kfc+jglFYAeyJpHx$Xsu5GLv07 z@AVtozLp|69;dZA_1W_z##*pC+OsD6pgJw2bNdlXpCl_};_|cUMXK$!0c6APwP35# zyx9|KKG4oMiQMLn)#UKv*dpyw4GD|vdyX@j5M*+R2Zuifo+0^%h-8%J_uptN))8jx z_PzU(@!n`q!%!o4FM?vg`7nD#D|C40oppDNY=4<5>c%Y z{it_8tF_-i+_DPHYCkqs*nukr+6bvINaPy^Xb0%d2R{_mNux5Hj36FmVJgGOl>x59 zb6_!PpCFU~I;cUbdB{o>sq$^`aibq9hibmEDL9nWZ=yn@{@`h{KglM8^XaH0(gLh7 zGSf~CAGp^1#T^q$E=P&u-7f(?yKH`ItgcR_RG0?wR714@qkZFQ7&vxII2DlH)) zAqodyDdgwMB_>-W0bzmRg!Axps9x%_jKO?!-mITOag`Q*R2#*LveR=9Z9kV#!5F|k z7u}E9fjnvG4>6&ftKbuGPZ**j$Q;@lZEZ{?iI z4B31=PKl0BkKg0Jd1mL2a4*vj^W72?)oZ`yW$$Wk1?5`{@R^E4-IFgbR&gr#h%;j#pE=Zq|Q<1=F1*+(KWJ#)s!cI`55N=-@^-q zuV`XKzPEopPvT?i@-sLSi-Mk{kGJ=8G*>QdAZY!!BKU%!Vgto#$DUsS2BRq^5-Kz&W{S zPr#W68ymBO@0q$F<0a#Yh5g$X-C$tIINBHEjompi>mH*hp7zy^8F99{a>m;DE*6KA z5H`%KuA-Fm$J={+UAp4v;*wTYRwlZxouZ^ya$of2i*0M2F!88N=IwNa(y9>2YfR<8 z#k=f%iGcV_-=2~I(}4&S)erA)k$g}bS?rOOGA57OPF=azY0Y*%CM`$>)MCMyAU%TA z3v}wwQ?mU1nPmn(IX*;MisHGyyMDLF<3*0Aw|7@1shc?cDiU_a?{c`38MXe-gmzKK zzCpv~3lp969<~VCy}r~sF6CD595(RsrLfMRMbOB2w%h5ZcTa6nTA5cO2}Eei?Bc;i zJpMgfey540r6r~kJL07rq%18hn1Ql_TM|p}bjNW^@myW0{-Dt+mQxvLB8pu^7Cs3N z`68d_|6WS%G{eoFsPaERhVA=Zp=WK?+)jUL_TwJebt|#l>ic$oUvJ^#7A$JV*4?^h z?=~98v(KTcB%1v!C-+8wkYf{skN1%O&3ROm@xA31+-9$*UQx#f7_r?NfxR#k8`>U9 zmRp83REnFPvTc#ke$s5g*N`PA&cQA5D#CY&5)!z^Q?^x`UAW9UQ;Ba0t8_IMP|B!$ zg+x2BoV#(I;c~< zE5GW;d@9I}bTyT3p$k(TLHTX*G`sTA-h-PKhDCyFnr&3o;f^>7f&ws|UzNAi4>QlV z7gKg}gIZzwX71uz-R6uR4!m@d+Z4OflIUjvm+#U3{Gq~FOW|d&2qv-5T0wKyjZuqk+b6~c?fM>R&i8b5F|bb04?f{dXB59Zq2ZK?{B`;>K> zWY(CSjhUFZJobgKYJl4$PTUX0Y1U90$*mFoXdC3&TK`{f+i-eGbFLxSvz4CCFv-wJYG;)WNyn2SqcR4#9zE(KNyv1J9%d%*ev?AKO&DZ*Uk=31sNZ zwrAS-^6Kf7k{|;B4Cd=0H(QD#>LF*6v-P_qLm=h)VRai_lh9E5&4U2(6OduAKt+kq zJt23o_nS&q`>V!?yD#M5@!c?bxsKHhA;|@or(AeG!hz$Afl`!r3*}<^){b0dA3&c- zn|;5tJf+a!kmD=9$4kC!S3Oe&^h$4)@h#uSx)!1#+b1?XZ$GT^ zC36RodA;dbyXkvb^}dSx5fFGVa!z+?NY(6cBMFuF{zR&ZZvls{WWY||kVSX7R}(v& zNGF-u`R)d6KX0(NDl=J)_Tdue{rD?K2?w_sL~Xpazx2`rHM|~Wuk}-yDn`#=Q;9_i zT5S|*`^M_p*}E)t@1%#PVx}EmQlJo;hJv@*aUrr zxr)oYRLVkJoS($(&8JP07v6a6(1yn97!?;P7b3cQYOGmk%kKHOkat}bJC3WTQ1WGw zl?!&#N4g*`f^du3evFZidAhW1=_ebPb1a+4%$({R(s=BI;ReFm|3$P`Gcurhw6O?!F4+adyj=3rRo|y?3J} z>}$^z16?_5)ZyXpRloK08J6$Y*`8W9`GHdhnDAK?WZ^>h92bf^Ke#nD=JCa2(k!~H+p b?VmezfA;HS$IF@He