From 04b60af15b1b3e268f40aa92f14035efdf7f6868 Mon Sep 17 00:00:00 2001 From: Christian Schabesberger Date: Wed, 20 Feb 2019 23:39:25 +0100 Subject: [PATCH] add full description about normal releases --- assets/rebase_back_release.dia | Bin 0 -> 2390 bytes assets/release_branch.dia | Bin 0 -> 2038 bytes docs/05_releasing.md | 39 +++- docs/img/draft_name.png | Bin 0 -> 4511 bytes docs/img/rebase_back_release.svg | 338 +++++++++++++++++++++++++++++++ docs/img/release_branch.svg | 270 ++++++++++++++++++++++++ 6 files changed, 646 insertions(+), 1 deletion(-) create mode 100644 assets/rebase_back_release.dia create mode 100644 assets/release_branch.dia create mode 100644 docs/img/draft_name.png create mode 100644 docs/img/rebase_back_release.svg create mode 100644 docs/img/release_branch.svg diff --git a/assets/rebase_back_release.dia b/assets/rebase_back_release.dia new file mode 100644 index 0000000000000000000000000000000000000000..06ef71363145dfd6ad9985fd387b976c4e3a099e GIT binary patch literal 2390 zcmV-c390rUiwFP!000021MOW~lj67)exF}KF|V{*_sg=~Tf3=E@~~A&WjD{10X6N6 zv5D=zFc10dk!<&Hv$@$~AQ4qFT{c3WB#ypwz9U)u_|yA5>b>eT3zPVvj{xlVbUaC> zVLW^2|MQPO-^u<@kDq>=hQSZ!-z*L0J@bh;vsVxO=R9BhaDV^y_6DM57UW3^qVNS| z`u;yb6b1LD(0%{$Q?IvP!8FJNd#}11DeMKIIjR0m(0D~IN#)OnRJbh=&fe34|KDUvT2J4G7m zvH!1?sY+$0P&|A5{4@PrHmSO?s;jP{jUf3vNM~WZi(^J7Du)6Ci7__A!IV@`P=P+i zMbZP#E6Q^IvTR6?1NAHfllCt)tquO7?EF4F= zuJvJ@cUJwfo9eeMpzsl^kGHhAvbIJiG?kiZc8(L8y@XSp9Wdt2G7U97SHU2H+c7=r z0A-TIvFVNpL+=)enXXwkkjI*0d21^|El`b->9lI;UrobwI!kSE+N|p-O8IK4K?x7Uvx6p=2H_xOn=wulYQq;VLFL)4Mm|2 zC<+ov2Z$S)#H2%(LJFt~Nf;zcRIIpGfSiqNMk+W&RMXIS>$7Utk)DqxNgD5_4!Rz~ z0;*5}yTiCrvUGzrFlvFdLsX8yjE>cZItBsSBE&XemWW=`U8~qfPp5!9g;8__$ab#m zG!Pq`jcQVIheNWH$E)y!&71~zbV#ixJ!u4^a4~vL((tSC%R#iab6Y|C$uNd8tygyj zlD&*=wnq2Q9;9QO!dkHUoB7VxJOQjc0dDOH5Wp25W4E5b1|x_Oi-ZK@LxaqOKm+3u z6z2RqWGe$kI-c%`n4|kyUzAE|8zu#(=QYesq{(8tJ#~4JlPEl%j)F8z-kRra+nPs_ zj%WK>o3({F=ogMeSc%wdhmk+t={=h%RE7L`Qp8TZ)w>%!_Yo;>ReIt?ZBUh@?L=ij zFgCcelLj+~)3n0D0CB;F-%u&Oeog5GrE5XiV1!;#-nycsZRrUy03pKzWQc=e>QYfs zpeiJ2kcLPAN}#!>fN?=@S5bB{gvTjLBfZyUms>^I4VYJyUQv2Q*`cERMSl%-+Mp|0 zYk$CP04Xdh)3aImIDcS}kcmnx5@NW}mAqYAZmhqK4l2sV9@Z8$9EfbAFh_^9Cq}0E z%xF-B4;5{lfGnNT$Qnm>%G9lW&r8|MN?F<{Wt%@s>SZvxkPPOn^Hp}1V_{ddAXYAg z@COnF0t&^3D`d(TWnK<@IoxQBUJzfQAU@1aq62oa)_~p8lI0{03q~qzk73V7o{egZ z&(qMY=jCKuMk8KW zIsx-}IiHvFc{%s7scM~(qb5?c;iB8M8G~UJGaDM-r>NMGd=v3$YFIPK^ynQd!B-!w zx(-%rtkFlSHz}GCY#*Z*mcX0_rv)uBX2Vj!gau^q7Iy8&MdAqXx<@?w^Z%9f__EhVZCFm&?4C zPh16**9}+~U?|N3!2ycFRvo;my!cp0dY`I^JW}L@u-|a#5Ec7f2Ph zNXTGW0Vq(h)X0gV?)6`NH}^=zHfx|>|J}$eKWZl_suz!!+DVF9Z&Ak#NNfBO5vNI> z4;+l_wg@Z%k<45w&MCV7{PVwG!pWDX@ZD#io$ueOw@06bzWL*Ncn9b8U_q4)#4*Ee z4{1OZQ1L7cHg4Zu+SOWo(}(r69=~G}TL`Gl7k8NH>I%%KzI^J-r@k(*Fe$n?tf!)5 z=WakDTHrubK2j-|C>}Kw7dfh@u9uD;f%K~MT2(1;p-R8g^NpzWhJDOU z`ha7F#DQYP<3!((1tiQrQsgCRvoU&6dYgNrR0l~jED5)13QCyca~-6R7D-5=QMO%N2zFaR2>E{qLOM_A;4aRHCj?nyrA#^9`D{}kB@(en zHl;)DwK9}`Hu9C^blMN0->u|RHa=zJQ#MV5Hi=P&L{Iv1g!;hc-3y`jr IhLnQ<0GRQQhyVZp literal 0 HcmV?d00001 diff --git a/assets/release_branch.dia b/assets/release_branch.dia new file mode 100644 index 0000000000000000000000000000000000000000..93e35db36758162a2444159ca7004693d9246bf2 GIT binary patch literal 2038 zcmVJPHi|yO&w$JgFoN;^=Mwfje+iG>QEn zn%)im{PNQcAAEOz^~n$9NBwV_$eE)*5vAtpZt$38^N+W;&(F^wT&6OM6A%UqkgD5% zWEjd@-RO33f8{vq9r!Yn=3aSMW?2%97nyP*Ia7Cov7CIJCh;Qj2Suy0-6Rg<#Cek8 z-QdGR`5N4o9o=s9w4?XAoT_o6Eow^y-AgQXs$)LV7uf;KF5?!M8Oz9&UVI zxbVDi$$8;|bTp5XERjLB4LOeEP|2u3&60&W9Vea0P@CAUX|ZPd`0jIuy;m`s)55z{nLWhCb}S$tFB35!Va_%AiF%>R$^^C2_p0A&(Kk)DnY zLvQA>-mYmkkcXOLajO!c=BV1pR8o%g7d}`tKQbBlGVz@o=ZkvD25ZsyzzO`j!Ef&7PN*)Q?oCGnTe~@5#gg;{5agNwk1$f* zrQ0jkgfSjhArdp+Xd0?@7z`LiWQZVu9x|u|o`#v3)!4(yl{QTVmIulk?J6;~ubvu$ z>K(@16xPI1R)=NoI}bWQ2$ywq70;CZ)I_t=XO%pdcYX|#NvLZ03AW`Y0)eBG-`12A|2uk)*{qj z^>?=B0o>99pw=D$0#tG_w&?*hS#nCT!SRT|CQ2oU!)xse5OvvU$R_e1smR~bEeFoB zwjt!Yp&8bR%b~Z>WL_OhT^i&l@{atGOp^GydB?Wxc@(N>x|^>_TZp|L;Xs6yW=*%a z`0X9%QE#3y$j{6>u-A~6t|4*j92Y5lD?C}v9i|}(fF%xwL&yN7p1$(5vLu%)B0E^U z!$hQq$hy+9DqTTQB6|_pp@{rJy#^|2kdmaeBcK55y>2L(dsdG-DDW`n28eOQ zb1g|RY?Fu^tJl$971=bw`j)zh$#+u3=^n+25Ydyt0DB(Z*R*BAvG7MDV;Si&`?mJI zUcjDLz~V*$+x%ItUi`u{iC@|}Kc%+?M9dssxk%V#l{X{|n9Bqiu8=VynDipJ7r~9j z*vsH|D1-O26YGGTj5Q#;v}8Dmx;Z1|wntFUMm-zV7++6Am!6H|Z5c`EXhpa%ue2bP zStKT54)O{lu91ci>c65m;5!xgJ!IrMS-}Hya+{37?B?V;0qb*eeNL{=$=MH0MeA%F z);w&YMVpDZ9K#4^GR#XWNUoMIAv{eqYsyrOUceH(_OYt<3gm5T?1R;d)XdOrAEFku z=vHIXoR$bNQ7I!Ve;UHQ1YVlSG*d}WNVW-S+X#C;df$B1aBK-%KLi0?K;2xpBD;!N z10li+B$wi$z7|k0Q)~(eMV4z|o2FUYl5m_C!9thtz6|z1b&AMsl))bN*b-_VLQoSO&c=A~Zv~ z%sSm0Bpvf;dMC*9*w7Sm5rp&dTne$x;E(M`BMQnul_CB?u>IU(H%x z-FA8dL;CU0Gtju2p!Ykw((u=|V>1Dty~l80ITOBdWj-1t<% z39NW!3>paZaHY&yZ_PY?q}tWyGXS z8AM{}>1dgGCaM<<^9wj&{`|Z1ki;`*qX6bAi=E=+`KqU{GtgJPvG(+JnJ3V^1Nwpj z8H*qu6wLCYvo1DSMoc-@0>uM}kUYxLmQQU9l%{#sCoU-y+Q%C~g?oka?iEULo&RX> U{nf^=`rcpt3(4k9`|e@@0O*_RC1.apk`. + Zip it and post it into the head of the release issue. This way other people can test the release candidate. +7. Test and QA the new version with the help of other people +8. Leave the PR open for a few days and advertise people to help testing. + +While being in release phase no new pullrequests must be merged into __dev__ branch. + +This procedure does not have to be done for the extractor as extractor will be tested together with the fronted. + +### Quckfixes + +When issuing a new release you will most likely encounter new bugs. These bugs are called __regressions__ as they where not there before. +If you notice a regression during release phase you are allowed to push fixes directly into the release branch without having to fork a branch away from it. +All maintainers (people who have write access to the release branch) have to be aware that they might be required to fix regressions so plan your release on a time when +you have time for coding. Do not introduce new features while being in release phase. + +When you have pushed a quickfix you will want to updated the __release candidate__ you put into the __issue__ corresponding to the __release pull request__. +Increase the version number in the filename of the Release candidate. e.g. `NewPipe__RC2.apk` etc. _Don't update the actuall version number however :P_. + +![release_branch](img/release_branch.svg) ### Releasing +Once the glories day of all days has come, and you feel like fulfilling the ceremony of releasing. This is what you will want to do. +After going through the release procedure of having [created a new release](#create_a_new_release) and maybe having done [quickfixes](#quickfixes) on the new release, +you will want to do these steps: + +1. Hit merge Pullreqest +2. Create a GPG signed tag with the name `v0.x.y` +3. Merge __dev__ into master on the extractor +4. Create a GPG signed tag with the name `v0.x.y` on the extractor +5. Make sure the draft name equals the tag name ![draft_name](img/draft_name.png) +6. Make sure to not have forgotten enything +7. Hit `Publish Release` +8. Rebase quickfix changes back into __dev__ if quickfixes where made + +![rebase_back](img/rebase_back_release.svg) + ## Hotfix releases ![this_is_fine](img/could_not_decrypt.png) diff --git a/docs/img/draft_name.png b/docs/img/draft_name.png new file mode 100644 index 0000000000000000000000000000000000000000..4257d59749e80350ffa3df8a427927c3fe4fab10 GIT binary patch literal 4511 zcmai&XH-*Pm&PwBf`A19X-WwoU783H5XI053JF~Vl_I_O5=23Y0x=XJ1e9v%MMP?1 z0i;VXp?7JaNfQDA-Z-;ny=!L8f4yJsx%YfJ`|iD;{d-Q_JtLhn%)HD10G!d&g_r;U zT^sE^oQa*|CeHrcD7XZ_6UEHE;{8vucNtFHu{a2Z%%E>Z%E7*lUE6Rp zgjX*OkJm4W5`G;qy%jNLzt8sTFq4X!3(gLI%`>sJvZdCD3{vB#MIf&$5XcAs*_UGB z0MIXJLI*&e=`sN4&wx0ATi5=1^E>sNP2)rl%kk3E63_m`OCN;{>97^pYjKt3HJ#PuS)8xhpqyZk?7|G2psH6QlMKeinCIrK@jLV_Z5#EBuXI0Re9ZNMJSE;yDQ8c4}%rqcoZ(UI1N zcOI#x;f^XdlZawYHRZkGl;{!{5FbhFfI}hYesgh~l1)k4IVMQ@6uiis=n;?FpZ!xU4S!}SWd1GEEMW5wG3 za)j7AeB%uJJ0jP7&%99tiEM5uc$huQXx4Vl(69*4qJO4KTh4IZpx}2|2Ur(vW0I+8 z(*=35vutkY%R35v7p4hB3bBXfS4%AQlMH0$C+gDLu2>ruX3P6$W^~Ah-=*Axw7W)M zMG@<&uPRzEXjJ+!(}STpB&UKN=uf9Pk8<1$!nkjdW!FP@sibT8(l>3FsI_YV{vPwg ztEPE~n{AI&JcU4@u1T~zic6%XX-cqQzjq2{T&!DpBg)m-OM=@+5@z7yl4K@5$Q>vv zD>t-mGvavzNmiuX*2e7sHzBkkp*6h>;YdRn%I@ydmoU;7{_Ba9K*5gz` zR&dfek4rgZ?>&VcTTpR40Kq#h8byCPN_dGE9la8DVzL0 zIC1~A^|S>XX8qEX`ATnF11Pc8LrCcZ}wEdgm1fmpb=#{fV9XlOVO4x4EyS#_O;6idDpB zWgD9vHUz?oyTYcoPy4$(Y)E_GtmaFMn;3pdj_x2rP|8ZAs{{7t=BKqdMJ;nwbiqQ} zw%f*459VNlPo4y*JfDe%2JXw1SBUsZmtA2#N(%K=H4#+{O?pb#Ov z?p){{Nw)FD`G_Xb?d@%~w6m`q|H@aX4^>4C2iWB^|5X7w6^jkVe-Of+uR1Q)8`9(X zL$@l%P}CD--nzbiXgt&+@MgZ^+4743URZ2I+_c9rXkmJrBKX_x|vw{jPW=!Y1RpaH<^F^@JMiue#nJ(9(vSd~@ z2AWhpm(y?dt~sc6Kz#D9QO#$+f1u#$QtCm-B6v2}03;MRu0gMAiGeG4(jX{wRA*f} z1M@~s!fdy@w42lVZbTnDa%Vsq)6#^Bz45UJ&4J!kK3cPyaDLIfT2`oNo!)I^7<5Hm z-N|*J_Gn$So;7n{pV5)yDj}R)KD*)lO3Jv1=rFl%Me#FA9LKW*dz1G=2BIhUcX;U(6|r_8(RnC2ev5=>Y!Ey zF8tFRZ(g5G=8gVg|FvhzTW6zxUIAWe-?rJC{50Gw?v&9JVDq(lPIZ#SVt&*;!O?so z{FXYR5Bcf_h#);yRW%(g!8+x(3TrS`fj;#&VpN z6~Ss~tOa?67V{L?X003xO2!B^=wE#*7SHX62IQD&WBV0)d|CM-yaneL3zC1Yct26XR6o~lCJ7hz#jL_>?lE%vS?6XZ8GqKIzIS9W1>o48Empt zjggW%ni0CLB=Jk1fejpev{8*`*)91oIi4`O)p_RfC3NlVS7DuV0+wLP^xyxCS2pPi zY-z7%FTFlGBih9!Yw1xtY!RSov)X+0`guH&##lZkbQS&H_=33J_Nz-HPUlYY9ZOx>6`X> zHiV;T=V(v)`&2R3<=U@UT5)NP`LYw4&cS4-(VMC0Oa?IDv8Miqu@LOLVXe+R(**u2 z2mD%S;P>+&0wOeC`LN7q{irZNapAQT5l39|oqW*vd+A<|*6&4H;fQ@f@zch~9j2tW zr~YAl{3p2n4;T)OoXlz6OdMF8+%LI4%eC?I#4_b+oVAh%fn zyOYcc+$TJ9HM8k~J*F$%RkHtRDjq>32P5p6lwc>IILf%QsO36pKxKYPSYZ1DX=|g>uma>y_!kJ z6}n)3Z6l^LAN^Tw#umR=QwAazqXY^@&d#Z+;)+X-4^xXvCBXh>3Da+k8yi%tiyneL z?0;z*9_#3{I+SF|pY)~TJNKT(EpY_h#y%WoidhQBaU}ekgX1!l zG0o_oXJv-)9Su#)f^u!s7aDOoR*^n;u2j&#OtuNGF;IiGMH;Gzdz?T?@1on4z_ICapRpeo}( zn#d$u)^#hN9{-!8b2CL-Lw27`F}My=Q0D3O#&#T?`_#}r@>89+djj$C-A6&wB8R*S z3i|Q3@Q*}g@26dx?ubsC4IUK2&Nb>dObWnPo+rd>pkMR5ySP=M$|x(QHuEb?pi~oR z)SX3Hke8Y~?~YwV?hkFnUzMlg;jXiVtrVFC!if6Pid`lxnhWpTa|w$%NlOaXcx1yI z(0>T5F|i!-sJu_Ti7g$li9L)KrSZ*Fc{ipIW*vx8*u~ZQ4eOTe@KHw420l`k5?owZ zP-~PSb0BhB@LM>R_b_U)Ts9E%@tZ?_&=&MyhM>~*Ie!0aiJdY}r>oU9gX$u7Hn3{q zy146hZ_|Z7?|{Tv6)q&+I}5{}1z|4e@^J|?HciNwExmHbvej8XLMEEWA{}?{!PteG za&ZjX$|a}u5*9#?HM&7I725gJV{{_5X}P{dE6DM-mZ*7yFLd7M0UKC7uXNvky%3&G z`Le`L{`tjE#yB*1zL>qa<^+)iRT6iFMt3%a9p&X0;wAN~Z+a*DXufP&%zM<_SybNt zW5tW9l?A=F{m@Ep;HegOB`sIN8#jv^ayAYS+J}xaZ{!uQ9J{op9h(kl^qgFiKVG)F zzmgxCdfVgwalHSA?fU~y?F zI7R&=!2R&AU|G!VdGCgP(T$|tI7EK_9Ix>|2K@gX=f7MzML;Nby1)69j|c6F1<=zn Kf|P68Mg0o`)S5#8 literal 0 HcmV?d00001 diff --git a/docs/img/rebase_back_release.svg b/docs/img/rebase_back_release.svg new file mode 100644 index 0000000..1410a18 --- /dev/null +++ b/docs/img/rebase_back_release.svg @@ -0,0 +1,338 @@ + + + + + + image/svg+xml + + + + + + + + + + dev + + + + + + + + + + + + + + + + + + + + + + + release_x.y.z + + + master + + + + + + + + + + + + + + + + quickfix + + + + + + + + + + + + + + + + + + + + + + + + + + + + REBASE + + + + + + diff --git a/docs/img/release_branch.svg b/docs/img/release_branch.svg new file mode 100644 index 0000000..d0803f4 --- /dev/null +++ b/docs/img/release_branch.svg @@ -0,0 +1,270 @@ + + + + + + image/svg+xml + + + + + + + + + + dev + + + + + + + + + + + + + + + + + + + + + + + release_x.y.z + + + master + + + + + + + + + + + + + + + + + + + + quickfix + + + PR from release_x.y.z + to master + + + + + + + +