From c9b81b0717b7749954b1af47c12a4e2e00c80b04 Mon Sep 17 00:00:00 2001 From: Jan Hohenheim Date: Thu, 18 Jul 2024 05:58:20 +0200 Subject: [PATCH] Improve workflow document (#163) Co-authored-by: Ben Frankel --- docs/workflow-itch-release.png | Bin 0 -> 6184 bytes docs/workflows.md | 27 ++++++++++++++++++++++++--- 2 files changed, 24 insertions(+), 3 deletions(-) create mode 100644 docs/workflow-itch-release.png diff --git a/docs/workflow-itch-release.png b/docs/workflow-itch-release.png new file mode 100644 index 0000000000000000000000000000000000000000..ab96972c80535061eddea8497de7d1888ba99f1c GIT binary patch literal 6184 zcmZ`dcQjnxx1)sUC5aG*WQdaJC1OMblW0MRMDH?6h&qTiT6FU1216LpVi3LeAc@Y5 z=+TB4Ekqgh-MsJj-dgXEx7I!P>~qfE`|N#pxohvJXWFU^v^Qu$AP|GP8cYuaA{PMQ z&zH%8_dkizXTU_}p{J@0DjVeb1uQ7-l(dupg!go(R+oS^jjNiG2MEO2^>>iMUTpvrKkuwoCm zxV}bL&BT0FnAS76Gep@4RKoDl)O6{Zli8d`BTN_}NE z0YyB_k=j4P8!3t*9|kOZ+uYKNYB@jmD~~%nImRkv$Xp;V5|psK5Xo9?%CWd!6%HgD zvHA2gB}6um(iMa7dKm;^2ae_K(fBdb@`X z9zR=)SD(E(No7)hOL)%zP`Y1z#WI^;T(oS@(_C6 zw~L=YbHOHsOfFxs%(}7iq3kKx8r?ke_KQu(j5P}!6M;2WgJ9hX9-tcy3!NSjBO~#- zZIe^vL~&O3A+Z+5=TV5dD6l;^Oo{axLYr17FWM2EfvOwyp)gj3RWph(LOP&XZDbs@ zJ@V-a%V8p7XTIckqr$+8m)Pf0dw7n2St?0gCiIxE9+lH*ye2m+yvKus%1F7Oe^XV* zN7{qm$X%H}^FuqLZJ~;Y)Dq-DD?YcSD1?k^r0WDO1)-(WQZ1__FcYjHUil>*A3%@D3*NyhUP$Ewkn!pk{;kcb zlj#%`BYxgSX|7Bo{m&ya!x%MtXH;%A^B3Jb24Qwu$^H-bBSo%?@{A_7hkURK)1qJC znTJ(C)mf{?q=V*4;WGdcY(#S6g28lw1 zL8r$iUfle!m_)Sug~?3G_on7)JkbHq+McWPv7!h9hpz<2gN^0ou~G*kF_>H1jID^n z9H^6|#ckFoFK_R|gM;`a~PZEF*xXe=$bD# z;+bvxrk@Ia%`kYL@2yxepjzN%`WWKRB2UXb0x-L z=^jVf3GEOGVZkoG)A$%N@~gV7%_W2Ixt(|X*1Pgp_7&?bjr3C|3x}lUSH(J$fxq;S zt%f3mvd34s@0&|QTi1O?-pS`ay6I`x(Rqzau*qa*-8d&U=_1yYQzE+Oavb-4A;ix% ziaTCX7Q$of9rd5#4JRhAsRmfJm!2&-i294aiq8ooc5 zoldVJQ@HPOZ>;-d{WT2Blj|bp8G1@LFvbD9d6NZA1)F+2Y~2LN?Yjf-nNBpO(G2kp zZwn1sQkP%ueMu_8j2cKdW|yWz5n20t#3xl!32J;lKl5^DD#+)go_-jN;~0zk=aK*J zwcRJH;ekG9RL7fJc1PCU%Iu5u`$dH*d-AtbfiOHBMhqeP1uAM4rPD%5qw)qeSxbneHy&1Atp zRyuhWX_Tl99x%|vNkDrw1qvB03LNK91>O3gIqCbJKh%5nSMAQ748g@+9QV{rGN`Mo z2Rel#-&_`fi63J|5i#kT?Gs%;r|8GQ^Hdqka}th-^&OdVu-dgKSROJITF$@Zs^Z!4 zmKVR&*3YzcAO0!PGeQ`|s!%+>(dM77^j0_(od%6nH^(LKFcXqHca1%HauEK!wnQN1+4b@HWY^yGz3KsgrPBJ4fjb`;FQA4*H5f6THTPW1nTWq7EA-(BAMq0;6n(X==Qu~3W!_5Oz$OT4z zc(mAKe8V>`7ce7RIyp!rZx5hDns zPYrs60D&}_ab%!pU=RqHg4RKxqCt_9$FFB9hfgk!ww}aUDA1CDPG@lvNmr8C>T?C% z&2;Ox-;5t&#-uwbKuABtxM|4oH**vZSLSv0%t8`@|Jh%feZyrJDv-XaNVeV{?Rtzn z{{$fXrmQ-D|TAQvDCAk#B&2?gi_6p*ZF5QFgJ)&+x( z7ywXeh`OhTN~26M4+`43tBd}++!tnXl^a0TxASrjMEGoZ9Yp^LJXc15gkR{}%@ePz zE@`7%vQKRu+5Yrf-ygGE(l+&NSuoIF)z->Un-`GB8C8PB%ahw0tB-ile9ci*qTtlhv_@(JkgH?VFKi_^Xb zjWuO+%)hpqrQPr!hio9ntCWc2-sa;3iT9B{y}mOXtK0+ng>5Abr4!;X`haTTLmAv} zB%oe)JwdW?i$&s3N3F{Nb)l44vl}Cmyv0oagBvav_=iQD5bl;wC8VCOlM^+j$Lp*d zqIaK1*u^6D)cpXZ{x75tuJ#tOv%WH_sYh43n$#qYT zlhg+-VVgFN75mw6dBomcP^7L2;9KqUpOU8e_`Al&7R0X?447{a>^Jw>tsMn3{Py$5 z4&EfRt{Rkl@^tX?l`kLp=ipf3i?+&>R)IOD`sWh@RmIb&8gskH>L<&;0Eb9@f+*lP zwkN(PjVX@kAgV=vii*hkIgrA2vhOim4CtKY#8jLgTv zA@iI$)47_rUWl!fxahSM6u|AY1$x5s<1SYhw^6d)4_&J^5C2w^$UCRQ0{p9KOY3VL zhuCmPmm;?Vp&?3cU-1h&Ho$=Nb77+2JHG5-us-QIPJ(Jytm^x=qMJ7-MCAojEf7IF zhwGFuGy3=+`7h_X70cb|-@AD@_A8!fTaMq35V5Lr%6Y~01)^=Z3cD+J*)v@g6?+q-Gi1y1v=!} z6(CbwSo}>C{}Y`@XE>VJuQf;Z?&E#9qks=k;H=c``@O4=%lesKTFf}ccgV^HJD#rV z7WG1qQb07mI72F#lbC;_JK`@1f-b@i-YxHsv!38 z+_m$&+_It!L_|1iXlq^YM?njBPzkPq8dO37ND15rJVlKCPZPH})ZuW0p!J(_tL{M6 z!(q39GQG@H#K`BsSICpi$N3CQD}WeseFom~XQ0M)?8$KHui9-3`*W!e-oF9Y4znVh z(g}nQ&ojdZtlHEIywcD4^r%#6Ny{JVSu1l3%@XEZDp*h} zGkTiw-Oeeh-`IU(06$shVsU;`Lm)uc#FYxpKaCcn@UABpdPG%p*u(sj32r1AUj8!`F) z=+gG-wJa#=F;c!Y1{U2^DL*ro5EM>HV{ zB7NXV!AnMbdh@<~2|d2I)?(G#Eg@O;;^@lz0@ha}l#TeMp5KR9F8@_KB%NN80~jt z?*8?*=6Ozb(pOuQBKOJoa~+Y3B%#d~2QUkEFBXxwJ^Ov3wcxQGeiCMVZAq$@f@!{` z%8dof%ia3M6h@3ZGMRK)jy2eYtDV(`Un-cZ9W1KqvvPYggwlDD6UXzD#?LmQno zj{O$$2;5c66YE6j03@It%@V7-*sd(O+bZ?9H7_G!YFiS8l*)4??aFk4QESWIzsv*c2H|;W{qM_9$*^zIkpfWt!oP0NcjwEG_z0&eo*{Ng%ntc5QL2FnR^@14L7rkR{*NUiz zq!E2uvOmep6NQVjF3Cqlx>+P>GG1Z^Ol*7m$UMS8;7?DJSBP9OijA3}s@6mx<;vqQ zmZ(9YTM$$qqN$#fXVD(x^;s>h8Y7^S}lU_v5d!B+1TFzw~a}N z{DlnDgF^jHTC1gsF%jvM+xJ1`3Kw8k6@34McAOVoK3=)I0WXt7&GF zRCury|EuVEkRIGciLag3GMi>H(uR&~%#2J3OOo;5F-h%?x;N9m1r8 z`#XnEbEb~Mm!4a<1)w)Bh*nC8d;G~cw*JOOLzd;9Tav(aoNZnX94&<7IDwX}QZFL? zV9vtpWHr=*!dKWpVg%l*Czd}}(jFJgPrS-rJ`rQ^p3jj`!kDD}vqIJ&kNKsE6ME)R zcl_zN@x6Y?Q#S2f795-X%H7UZi=)rX4NHLk*7@Q8Xtp&U2a3tH+{ zI!=jeHF^}sej-zKiC;IiGEX;PYMQzZZ*J4>2Uy4NHifn2IPjRY=yCh3^?_L|}uEYhKkzEpJfqd5@nQ@JS z!>$-DhWw3VB{!D0@+7+=;JDBrh2U^~)@L@3b7c{u*j(vZHUj0C_AO5m@A%1ISl#DP zqy0_Tz@>g7H^$t$DPEFLR=t9sTnc&K~xt6?Fzf)zcHRT`oIX=Putfi5RtCUbj(S=w~mKb6VB-{nBO=KiMCyZVZHI zen&Pf>>!|dE85o!2;0+p9W54~$A3CGzgw(?oXZ#%UObgEq}|l{v6iD7Hfr~{i(Jk5 zvv$j&;LXpMK2_nJJoaAnCg+go@9|xB|JXq}bFJDq;vp^i;yLHMYoJE{s$=)Z`bcG{ z8NpWJbxnNaM)ifJzFz&n&zPkffI*pjRyY`tkU`&JsGABuq%zd-cg{H}y=w`1yef-a z1>m-W_4bfp&}DMV3z345s>e>`?YACK4?Vp?v6BpxEKrakHK>##2mz{K{0kC6|AKgj zlS@H#&KKAuTe$Wj*&{irB-`?;MUp8f=*6J%Dm$pz9SqQc{&v?vI}{-|*eW*;q}hS) PK1ltsHmpq9GUUGiKD8N~ literal 0 HcmV?d00001 diff --git a/docs/workflows.md b/docs/workflows.md index ce061a24..8044da5d 100644 --- a/docs/workflows.md +++ b/docs/workflows.md @@ -42,7 +42,11 @@ Enter a version number in the format `v1.2.3`, then hit the green `Run workflow` ### Set up variables -Open [`.github/workflows/release.yaml`](../.github/workflows/release.yaml) and navigate to this section: +[`.github/workflows/release.yaml`](../.github/workflows/release.yaml) contains a list of environment variables that are set automatically by `cargo generate`. +Otherwise, you will have to fill them in manually and push a commit. + +
+Environment variables section of the release workflow ```yaml env: @@ -64,7 +68,9 @@ env: USE_GIT_LFS: false ``` -Update the values for your project and push a commit. +
+ +In any case, make note of the value used for `ITCH_TARGET`, as you will need it later. ### Set up permissions @@ -78,7 +84,15 @@ Set `Workflow permissions` to `Read and write permissions`, then hit `Save`: ### Set up itch.io upload -Create your itch.io page with `Kind of project = HTML`, and double-check that the [`ITCH_TARGET` variable](#set-up-variables) you've set up earlier matches your itch.io page. +#### Create page + +Create your itch.io page with the same name as is used in the `ITCH_TARGET` variable in [release.yaml](../.github/workflows/release.yaml). +By default, this is the same as the project name. +Also set `Kind of project` to `HTML`. + +On your project page, you'll see a warning saying "There was a problem loading your project: No file provided to embed". This is because we haven't uploaded a release yet. Don't worry about it, we will fix that in a moment. + +#### Add butler credentials In your GitHub repository, navigate to `Settings > Secrets and variables > Actions`: @@ -88,3 +102,10 @@ Hit `New repository secret` and enter the following, then hit `Add secret`: - **Name:** `BUTLER_CREDENTIALS` - **Secret:** Your [itch.io API key](https://itch.io/user/settings/api-keys) (create a new one if necessary) + +#### Select the web build + +[Run your workflow](#cd-releasing) once. When it's done, go back to itch.io and edit your project. +Scroll to `Uploads`, where you should now see a bunch of files. Find the one tagged `web` and tick the box that says "This file will be played in the browser". You only have to do this once on your first release. + +![A screenshot showing a web build selected in the itch.io uploads](workflow-itch-release.png)