1
0
Fork 0

update versioning docs for new major versions

pull/252/head
Bryan MacFarlane 2019-12-12 14:21:22 -05:00
parent 40a502b14b
commit 871c495487
3 changed files with 11 additions and 2 deletions

View File

@ -42,8 +42,17 @@ Binding to the immutable sha1 may offer more reliability. However, note that th
git tag -fa v1 -m "Update v1 tag"
git push origin v1 --force
```
# Major Versions
4. **Create a new major version if breaking compat**: If the inputs or behavior are breaking, offer a new major version. Typically, this entails branching the previous major version for critical updates and moving master to the new major version. Keeping the major versions available to a minimum is desirable as adding new major versions requires end users understanding the breaks (how to adjust their yaml and expectations). Since you will likely want to innovate on just the latest major version with only critical updates to previous major versions, you will want to encourage users to move to the latest major version. For that reason, it's best to combine breaking changes with new capabilities.
All releases for a major version should hold compat including input compatibility and behavior compatibility.
Introduce a major version for compatibility breaks and major rewrites of the action.
Ideally, a major version would carry other benefits to the user to entice them to upgrade their workflows. Since updating their workflows will need to be done with an understanding of the changes and what compatibility was broken, introducing a new major version shouldn't be taken lightly.
To get feedback and to set expectations, the new major version can be initially released with `v2-beta` tag to indicate you can try it out but it's still going under some churn. Upon release the `-beta` can be dropped and there's an expectation of compatibility from that point forward.
[An example of v2-beta with checkout](https://github.com/actions/checkout/tree/c170eefc2657d93cc91397be50a299bff978a052#checkout-v2-beta)
# Sample Workflow

View File

@ -1 +1 @@
<mxfile modified="2019-12-09T19:00:31.174Z" host="www.draw.io" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36" etag="7PoPrvPXBLDnYEiAz5aD" version="12.3.8" type="device" pages="1"><diagram name="Page-1" id="ff44883e-f642-bcb2-894b-16b3d25a3f0b">7Vtbc9o4FP41PDZjSb4+BpJmH9qZbrPTNk87ii2Mt8ZiZEFCf/1KRsa2JC6hYMhQ8oB1dPX5vnM+WSYDNJq+PjA8m3ymCckH0EleB+huACFwPF98SctyZfH8cGVIWZaoRo3hMftF6p7KOs8SUnYackpzns26xpgWBYl5x4YZoy/dZmOad2ed4ZQYhscY57X1xmvs37OET5Qd+FFT8RfJ0omaPITqlp9x/DNldF6oGQcQjavPqnqK67HUrZYTnNCXlgndD9CIUcpXV9PXEcmld2vH1f34sl7tAA0nfJqLAhCXVfXHDZ3BPp3FzTFS8PZ0m8YbO89xHEXIcYk/9vCHyBifJMKzqljQQnwN4zlbkETN2Jq85JhxRQbBBDQkRXIr0RTlOMdlmcUr48csr/uIUrtHyRn9SUY0p6yaHjnVZ11TYylve0yL9WywGoqz5Y/1uKLwJAqOoIIq3kl+O+vSsi69ZvxH67rVS5SaTrJQ9zH9XCND5ywmdudCFQmYpYTbm6hRpNNbwyrsHgidErFy0YCRHPNs0Q0CrKImXbdbd/1CM7FQ6KgId+tAVfEdBE53iNVtqF4Nf8RFaxmNqWLVfgwD/rEptotNWzljw34r8muWtYj11CbdBpYdxBi0mzGwH8YgjTGhzpjVGk/CmNVEC5zP1epjMw2KIYS4SOq8TDJOHme48umL0Lcug6rUXlGrYkidvYEt+fjVxyCS2yUSkgPhPEsLmecEvITJBoKVraHGnvzbxoMFYZy8bsVQ1cKwi4VXY/HSKF3dZNLWOGcz6h283gKOKWeXFs47UvmhsnFQQPsXE9BepJEI9RbQ0AxoeNaABmcOaDe4nIBGJjjoqsHxNHBCeD5wXBMc76rBCfQsdk4pdP9I4Ruk0N0thX4/Uhigs0mhbwa0hUVXFNC+e76ATv9ld9++/p3eL2bf/vlU0k/x6IPl6WMA/VzMOnwWF2l1wXARi7Xd1jVionWl+MZTiVPxXMovwVWCS1KKNgvzMUZgNpOXMc5zOue7IZ8RlokblbDUnb40puGMlhnPaAGrOAbhkSRRy7qBa4IEYJ8oWXYtlnOGK4qj0D/frsWK0B9x3CaO20i9TSFRPwrpReAmAF4Aw8AT8hhEXW651todZ4nmJLBLWd8/mQxb3R3uzvQxI5iTlT9lFh/IJQ8rjNKN+d8BN85NMxZrKUN39K2D9C4WAsbjbNEDXSyAKRZ+r5LumGoRXLVaRBe367Kc8L4vuTg87df0PHVSDx0t30INzX0Td6hFuA/6TdzAcqAYXnc8R+Fl7f6A5QzxfcVz/9u/mtbt/d+2feLJ84V+ELrnS2NjIF9/Njndu0S7Y0+600N77PSmdEF2jdX7hg/Zf0Dy9uQTdh8PrKcD/W74IgPwKS6lD3QPi1vkeu5pp3yVqNqpW5mM9C4dlgmn36qKaZYk+Sb56WpOla/UojQpkY4/BkhAPziPIgMkG0b6HuFoGEFzU779qOx6oNJe94fIEk+207bTYWU7FNXlvfntl3J7gsuJTd33dtlOgWs5xLP4o7b9pg7qeAT6dndfHQRAfzQ+3cY58pbsdjn6b44/f83pr4enu+/hPmfbh+sgeHcnHqg58TCi00LIza/zvS6sbtSjAFqBNh+Qjgi0c7VAQ//SgDbfgxwH6O47LHgU1E3NeB+o++jSUDd/FnIq1H8/qb9X1CMQ9oa6KDb/QLAS++b/NND9/w==</diagram></mxfile>
<mxfile modified="2019-12-12T18:56:00.899Z" host="www.draw.io" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36" etag="CISsL8yLQ-3TSrXBbF_M" version="12.3.8" type="device" pages="1"><diagram name="Page-1" id="ff44883e-f642-bcb2-894b-16b3d25a3f0b">7VvbctsqFP0aP9YjkISkx9hJcx7amZ7mTNs8dYiEZVpZeBC+9esPyMi64UsdW3Ymdh4Mm5tgrbU3AqdnDyfLR46n488sIkkPWtGyZ9/3IASWi+SXsqzWFhf5a0PMaaQrlYYn+ocULbV1RiOS1SoKxhJBp3VjyNKUhKJmw5yzRb3aiCX1Uac4Ji3DU4iTwtp3S/t3GomxtgMUlAX/EBqP9eA+1FN+weHvmLNZqkfsQXuUf9bFE1z0paeajXHEFhWT/dCzh5wxsU5NlkOSqNUtFq5oJ1bF0/bswVhMEpkBMpkXf9zSGBzSWE6Ok1RUh9vW38h6CcMgsC2HoJGLPwSt/kkkV1ZnU5bKr0E443MS6RErg2cCc6HJIJlgD0ga3Sk0ZT5McJbRcG38SJOijcxVW2SCs99kyBLG8+FtK/9sSgos1bRHLN2MBvOuBF/92PQrM88yY0kq6Oy94re1ya2K3JKKH5V0pZXMlY1UpmjTXucCGTbjITEvLtRKwDwmwlxF96IWvdKtxu6RsAmRTy4rcJJgQed1EWCtmnhTb9P0C6PyQaGlFe4UQtX69jyr3sV6GrpVyR+ZqDxGacpZdRjDADo1xfaxaSdnTNjvRH7Dsgqxnquk28Kyoxhjd0MH5NfpgNwGHdaUPQsd1gPNcTIrHFqLHkki44ZixWJMBXma4ny5FjJ01cmRe+2cNTn4hWMGJr+C8k+LI06dI7bqCCc0TpULk8gRripIwlW6GrnqbxfEc8IFWe5EUJfCBhJuIcxFGcSKKuNq+LK2Y15D62+gaUeqa1PqHi99bEQ4Sqtov3eH3cjZDRoksjuTM2zJud/vX1TR4MKKdrzrUbR9Xc720tB4Th0aH14OGucGTQ2apgu7ZBx0bnHwL+Kgsz8Oom7ioGdfLA6im5yrckbO5eQc/+T3377+Gz/Mp9/++5SxT+Hwg/G1AyVy1MGLTMR5guM0lM92V5TIgTaF8htPFE7pS6a+JFMJzkgm68zbZzQSs6lKhjhJ2Ezsh3xKOJUTVbAUjb6UpsGUZVRQlsJcxcA/kc9FjUMBpw0SgF2idNuv1AACln25DYsRoFtk3BUZd3F6V3js6NTHQ6DvAdeDvufK2OgFdW45xtI9B4Tto6XGRg6hs8Vg43L7+x19yAkWZL2eyon3lKoGOUbxVvdvgT7o25u+eCUw1Hvf2UnnsULCeBJXFDjNWAHasQJ1GtGtW7DYhdDlt1xtrr+xYHG80y/IeW6X7lsNbwsbaB7qtv3GqRUC3bptELTUPMGZEk2TQ1IOokmVqkI1r6pK06aWGpW4qHShd7pgQqMo2eYt6i4ip5d+qIbyFVgn2f017uyQZdieewZFg2A7jV6laNh2ubvfg94PVm5jo24f+CrV1OvpsDrkoq28rtfLHuFsbPLGBy/ZXodXWRDXsB6F7ZV+ETSu1bymOzvULwLg7enpdI4xcFf8bjX8NcOfvybsz+Pz/XffcMFysv2s1bfe3H7WLvezLXUaCLn93rVx9uEEBsGeaz9rBNp09nEKoOvnVvAkqLddydtA3XP9K0PddA10HtTBu0U9gAdovWBGJ6i753PqoA/frVNH1rU59fa10ASnqxyoZYmt3D1bhl9NXOPu+fUgOY5bA8kFBpDsM22VjSB5LZCGcs6YpgoXMVbSk5tRkqlt4QT/kgudL0Em+XulmJ0iVDbPcQ3HSYHbIUqG874RVSKi6QamjPA5DWkay7S+zoMWG6mJczKnbJa9JwiDxqtLYFKa6UjwCAxltvwJ/Prdp/xPA/vhfw==</diagram></mxfile>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 55 KiB