From d86f57bae0ad302fb5777f830dade5eb6afa728a Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Mon, 20 Jan 2025 12:13:47 +0100 Subject: [PATCH] chore: readme --- .github/setup-compose-action.png | Bin 0 -> 7992 bytes README.md | 54 +++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 .github/setup-compose-action.png create mode 100644 README.md diff --git a/.github/setup-compose-action.png b/.github/setup-compose-action.png new file mode 100644 index 0000000000000000000000000000000000000000..07e931e1bd4667835ed31edf7020fbfa5e49c64f GIT binary patch literal 7992 zcmZvA1yI~gkT32I!FBngA-KCNu!~C|xN8gxZh>Hn@8ZEFSRk-C1P``I0)gNVoZuQH z*yXit+ax8cXdCeg z!EEeZV-iz^#AUOrWc`I?rwW{TL;IioeY6uMC8ykcaeF*po;81)HNV1ZRZh#mc6`y_ z94b4zyy4$@`>bH4`J&$^;O*A_X;wkGy^DvEnqF~59Xq$s)WvP{#fqJ?+tkI%)J1+9;Edn5 zUWSIobO{A3J@uR4Uz$UFSEPEodagv4;raO-;}JF(Ec#YDQnNMf=KlU@Z71bWi`7Q) zG5>L>nEhkdh1MbKTtUgdu>L1?Gq>E#qH}A8ivSq6vJ~{_A>yD!Tcz`eo)I5|d;=2fi4!h`4cILXWo1fLLkt zz|B3q0neM#g#oRpjy&^;R?D}V$9S&YVeIe#z{SzhBH=`ygBmZ>X#qgs`Wz4gy|)L#67^zcC7kr*QEyq-feOIMe# z7*#*3BfgM0r02Y|+VZ;dyT!S!d3Y{vWhsPy?qC2ex>y$tI`!OT@aNbqeEfcvXNm6e zU_VI)%8Y^}k(?Wv0wK@m>Gm3~53_b#; z=Hslf^>l$kgeN;SDy@Ht9tlYwD{*sfP}7SA>za=AR;)wLQ=2~WeH=U@n}=9{wD`dk z&U?`~6EnEWi}8C=_Qs~25tvV(z+G6?|EwBYQo(oD(m(TUy)zf`N09VAR<|q8ZN4tp zu2;xShIISme0jaZ5pa_Ez@@(Pb~{f0sR~fJ;O+P<b)G;&bcMzPhj+ZUXMRDYTxQxqJuB>-F{x*11BFj`w7F;cunTOTt8&3Z8h`jDawKg z8CRfe`BN*X;UpV&5rilak1ESBD7)SKwxE9RxmPdu+G*8}I|Nrao*t&t6)a-DCP@*v zr4i+EVF1`J`Ds0bWV$9{?ERpH)?d}7*1yK}nQQzIYHP`QxhLTMvh9Ez|Ng~iaM7n( z%}whki~KQI4`TO|j}!qkIGQRL<0&h}%D1(_9E?X-VRMSu%K_-+-Pu=YX?`-21P4`s#THEw*EDu1HZDY;^;>k@t&?H?LY^yz3vGCV4uB?Z%Z~o9 znQvM4b9-Jd2ogo%n<04E@#srB&zla|>QsCeZ@Rv}d>_9vomX#%nSTE8_GtlFO6nKx z2i8A?|K;Lwp*4E`&Jlu6!4HeH54iw^jJA7)Ij93^biQ@nO!fQ-ff3E<-sU*0X6l|| zq1VlA+U$7N>tgy&(-``haj{@YO6^<@p&1jY7^e|Dctx9_xb4boDbZ{-GJXW8FYEM} zx1Sd_h0OY7lSVIK<(grxhL^PAD$Rc#9{6ESFgym7^&Z?b{?Rz`B>^4=J_wl+Bacl( z+rxDBX8G^!LiI-oq@wpM4IG0dD|$hE+(ZuMZOa|*T%uTb&GAU7O&_3JcyerWYZ8KO zQ9Y(I65_5ao4d7V4zKmWfzR3(kpGvb|Ld?nzLVCMoxpmpnSv*&^EOmNWr|7RIo9e_ zbzy7v&+0u%fy5&j^**An&)^LkzUDgg=GH5HqrvfbZ!Jlj4I-=JHnwNNG)2Q_?bHDo ze3skL88L@NPDEY_zY|)m<_sCr``2Ia*3xkKAFGksO_Lm+Dl%Fy$BNSn(WO`T?{ffO z?KN_WiGItCTJ*By63q0XjGo%7a?9#{0=aS#H~eW*0!(owrJGS z3O)W7cgHK4r)m)OjO8(uj-KgEfjI#&PIZ(6LQ|u6o7O-@8ppGGqQuf9UMvsnUlmPw zem0tX582XM1s^@eA4|$>;1ODFphA7tDAJdVq}~dQwyl)<5b-ftu_6H7qY`85vdu}r2+YQ z_LGc@cy^I9BW>hZBeYMZZ)MXfY7bj>l>r!PARTlv`n0^%2!2&;3E+$v08+8Qq{tp* ztr_=H92@R8bs??fXrIfBek{{Q%pPM_1Tn!4t`a2Ns{mociIRO{b!!Ji#IhW(0QR)oCwSI1!b2~WDI{0 zO5*+@|E2KU2Ngc0lBS~8LocukZs5B&bU{+C@#~U_|7)FftyFk#vtTeNv3mZn>?K?d zUbUsFcy+}H8p#)dzW(4_$lIrDMP5I}sZ;|(ZLcuWFX62bMBhe1c|GHFiy4prK8t-9 z^dfpcnrxuAS59m#brHbbMv{YP-4NU_h!}-Ti%QBWU-ok=wJ1I%x8xp9oHmja5lA&` zX5%!okei6^G%D`wAvfYL7Yx%DMrrq#3#r-jO6IGr1e&qBY?PF3^6(7=eSM9vFJ@56 z;kUN*U2;Xx>l-^j@vI!c&)KK*1_Uhag5N;X%-n>}Ah2=S;ZbvHxetmZeb3HXjOqNp zcw=OhJk@BpWJ^@aa#(GOK&}PFdkYa{5!&+oplT$C{o3J_lHOAzE91zU&ArGfsSJ;7kM%; z65atrS~K@OeKV2y+~yDy)>hgA?Zjq!t=T)1#Kfu8-EPxH%`nlw)|r-N*c7Zy{V9J$qP4YF}a;>}e0vKO?zZ2pTW(dDog`C~lcwa6^GsZ&cOXWkOm)urMYDpFxeK0+-?K?x@Dny|ZUk=uGIY-+-JteDkt> z_-+t@>3j^}`%wNKLgC!deCUO9e-AEZK|kDNp0T_2zY?$Z(ntr7)p15Gh03`+0k@9FVXb1d9NE?Q(~$)Cg#gjdQ@Ccm(#bjjDE!c2rbRg&Uj z{@NUG{37lbJKc>#{Ph&RQFt%$jL2ZWlxdWyoQ`DUej>@pw12?LRxgqk`tpKA3=O*a z2B$$*Qc!~Ds6@;ZGu+!LY#6;&q3rDRr4}2J^S67eL^90%+>BwVs%_~SKHPw}J;6WB zRmi(}*)$@8)2{gmvVLgHXLIY~)RP27(a5idOhWQP(qu?tA`ELekvL|ZZWP>p^bOvC zX%5A+Pb8}d9w=X&Mzx-na~mUOhCwos4xL_~13Y2avr>P=ZNwDc2loI^UvUc_|5)}t zwg*m^`%sY%V^GXW_+S=xpqcZh)3fw%t`&5D%@>qJB7QKf7Qn9nPUEHJIboaFNxmY8 zT1^0s?|!=bCjr!|dJIM#)tU_7$bhD=Z4X^|zoofGF1WdZo0$*wtQrDGW>eGn5tP@IBCVY4(%aXuQ@QLYVI<8|&+p>{~R=im4Tr+wyv9gaC6#s#6drcpn*d*WD(vcgP~QqYTI>-hYG zCb*RhQR8h*4it@jicL$rX48sZ7Xb2rK$&UhGLw0w>CoRbgh5vkZsHO*U8X_o z=oJ%;d6Z_$gf6SdW8y=dd+95hi?2?muBzgY;OWj;#-?R8nL{NW4Y1yNk0==uwb zEZJXE((a{96k2DkDi66=2M}TD-Rrwc?(zui0e>Y-MrW$KZ!oD-qt|` zpLDf8Kv+6;%HqvywzI2e?Ae0&w_nLTqtjxfLMe>3Cf)el&z$D=-C-fSTNCx)G-3j* zAL_Ans!`L|NQ;t33C8^f8YBwH!SLN45%?Nm4l~azW)PL(?#sR3Q-dnBen=GoT;j~- z%Xyq-4u@j413OILrzbdFm>6awmjXnXZRj7#D+Jk#H+65S=rc| zZx4z>Dt}b6_D}n5IpW>@v>)>`Pdn+C4=B;P$YyD_N)i)_>6dkRoqxiE2%6f7j_qM+ z+2glik)A@6y72M0->&69C5w5)P(V_}kVts?VkvFem}+qc@+G4xD|%z(C)cU7sjW(u z_pwj-%ICnX_Aafzp4S&VXq&)^NfBRXeaz+ z>6e*_^Pm<`9-dl`_V;fjjnS|zF6!j&WaPK^QsYj@nOkt(H-0>e14GaW^~p^*6X7gg zWo`8ufF7u*e?q)ndi;A)HDtU&mKyfqO_|I`Rz$GEYzcEz_f^e~LPFqT^W#3c_c0C< zwOmY8pIxd8+dj_|6U8z7%xzJ)5~6|b?6;xMw|uGN>8k~1t^Xhf_NaUeyb`~h>lGDbq3-g zb~|QY!e{L_cx7<5lMd3{Z*;j@F(p(HBQ)}mo>ABDabkx`8@8tYv?p^Ch&`u$qvy#g z)Q$jRWu@b^jtj=LTAkUo5SBb>UoRJZV*LI46F9dKL1!Borz)Zp{Cy6HwS5QLAP*Z{ z`jYvLr4$?E}{a{)As4Y(FTzhyL zNeY4fy_Y6l)W%zVh`}#}{C7wBzo%pcjX@Ssgt~LRnLr3R*ge5wvW9Kq*>t_c~EJ^hlzc)_iC;4^Q>+Db0A^ zY)(fL(D{UdQB>~Nd-pNjxW2FBJ3*8IKT%7wRjHE?At}+|)MS4bcDS*8gC8uON*&uS|IeTk&X~ zU{nPYs4Cwx6b&w^c~Mn{-8y3>$*5_ney>V1�W`zVKDYlBc^nqLKHxr_Pj>>{;*B z141n0vK7?smX@*^l>&nQMlQi4M`)4RX=rc%^t8c25zW&FPb?B8@-MeeITZk<03 ze9*iFrng%jD*h;NT_@Vl8Me6X+>AH7)qPl2n!Z~f@$OOy6@t1t?-bWq0nCQOJ`@{5 zrkgDiV`ql_Ah!d-rRTe<2>0Oq!o%Y%2({Yvt+A9w_yy0 zpq*?OXhBIKS;yy0DaubhsWt3Kv6hlNlOo8J1(O*~ACCU|gZG@MJ?72Z~gceu`3QVU$Ca z`ii9)>#0otSgFvwLaH(JEWu8Aqz-kxyP)%>e_j3=;Av1ruLWYp%wW+!a6YlK$Sjak z>-lpI0w$v~SL<^K@RVLUats+EisHoo^f<61-o2mS7WzpI?eR{=UOwB9;4!P>)DNOi z*XqUL)x*6VMzQIt4i~Eb(tlxgJ0>3fIi-7Wt7XQeFT>|IazAf9acrX$V$<{(!Irs5 zf!Y$hMlR97OwWgM7=K4y9Dg89S<3CJE`pS%8koYcMmpa8HU@r8e^MQGrRe7(Pp;!a z(9qzkaUTp>Zmh$k4#y!MAeBjumyEv6U^=a}b?RQf{CuiVo%68?EP~oheSq6j^rXU3 zw)MqjdEp(jOhU?`Wvf=+Qbcf$2F15MVA$^PngPz5=iM|fSnBCW!Jz{}qm(t;c?1^L zM5-P9old^n1cxIY58g#O!0*Ajz{EgYO}{tKz;#P3!pdzByV!Ob+TbUMw9QljP?$>7 z_$)a=_8!y#zcOiX0<7-O=9mMSg%&ucSwJGmQCFMez`YrDM{+1J{opDkoOHES6XVZv8+`w}#gp&m@|#D- z$Ao5*^0NO=cP2ZvkC8ewQ_?5>$*k0=P~)|j_Ve3=LZE~pu)z|zjR;pH0`~|?s;mu* z{9;?{t-kC+XqRKP!EUbG4TwaUo{4)<*Ld>S4cx&&Kg;y9$d@p9KShtU=%y*>_m`ts z7nvD}Gnu)YIJo+VYbjPg#1x0=?32H27MN`OVQ1YEA1Lz_RC5WTUoy!pMxVq~J#CC( zkT$j;>|b>$NRe+6$Uao{Goi?(^1WHW zS*IYze(lJ^8Kw@U3(dYKL1|3LpKge9U&JOxO;@my%Wyd@Zoi+@)z)ir@KeVu#f^1v zB9|Z%e^ELc9ibByen3y*p>^o0H^1KKC2A8;5R*a3gt=mSoQNZhRIjyE0qMX(CY4!$OPUq+SEPU5 zB~8@~aliUQP&#eA1DaQIXAoSCOTX-tL#Z9z1|gzKAb!rfB5=2XPqM78_5I`gZ2 z$r+|4=}s{~MG*1yveJ^bDXBeT`%@`g(_yvQu4VNp$8;r9ZQX{fuR4tq9uMO{*f?+{ zEp4kXsFv!o1X&@#jS?Nqbng-P1mvq$F?dU?#j)INWMMH+%0NcRzj$jWBx$kW51Sp$ zT%@Sos+CkodX3MNtEmq>h8pX9*@gyRo&ts{2gO>sU!@yvHbLk~iNYoQp;JDhTEhj* z7VHG(jx9>oh^*F?#7a|Dh;$8RW`H8ZJqR`m@%{ z+Reae|HO4_jRK{)JVdR_Y@)D;i_3=}OGO0=2Ny9o{Kbbxn7t{-0!ttuuH@v4VCeXz zWLp_S0@uZk;y;;w}~F&UC}BbSav z{KTiPBFSsELByYMWFB;sOy=vIiNhKRW;q>$I=!b>wxx2K&myV>Ukg>sO>CSpSJG*0njQC-y%$ a|7C{glN^q;M}>_42%xGu;7`gn;r{^};_$x! literal 0 HcmV?d00001 diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a821e9 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +[![GitHub release](https://img.shields.io/github/release/docker/setup-compose-action.svg?style=flat-square)](https://github.com/docker/setup-compose-action/releases/latest) +[![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--setup--compose-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-setup-compose) +[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-compose-action/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/docker/setup-compose-action/actions?workflow=ci) +[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-compose-action/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/docker/setup-compose-action/actions?workflow=test) +[![Codecov](https://img.shields.io/codecov/c/github/docker/setup-compose-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/setup-compose-action) + +## About + +GitHub Action to set up Docker [Compose](https://github.com/docker/compose). + +![Screenshot](.github/setup-compose-action.png) + +___ + +* [Usage](#usage) +* [Customizing](#customizing) + * [inputs](#inputs) +* [Contributing](#contributing) + +## Usage + +```yaml +name: ci + +on: + push: + +jobs: + compose: + runs-on: ubuntu-latest + steps: + - + name: Checkout + uses: actions/checkout@v4 + - + name: Set up Docker Compose + uses: docker/setup-compose-action@v1 +``` + +## Customizing + +### inputs + +The following inputs can be used as `step.with` keys: + +| Name | Type | Default | Description | +|----------------|--------|---------|---------------------------------------------------------------------------------| +| `version` | String | | [Compose](https://github.com/docker/compose) version. (eg. `v2.32.4`, `latest`) | +| `cache-binary` | Bool | `true` | Cache compose binary to GitHub Actions cache backend | + +## Contributing + +Want to contribute? Awesome! You can find information about contributing to +this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)