barrucadu/dejafu
1
1
Fork 0
mirror of https://github.com/barrucadu/dejafu.git synced 2025-01-01 18:22:35 +03:00
Code Issues Projects Releases Wiki Activity

Add some release pro tips

Browse Source
This commit is contained in:
Michael Walker 2017-09-26 08:28:04 +01:00
parent 2e5f79a2c4
commit e20854e76d
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/release_process.rst
View File

@ -43,3 +43,21 @@ unclear.
.. _PVP: https://pvp.haskell.org/
.. __: https://github.com/barrucadu/dejafu/commit/44181e6018f1ffdfba2c7a71f6a2adfa314cc49d
.. __: https://github.com/barrucadu/dejafu/releases/tag/dejafu-0.7.1.3
Pro tips
--------
* If a release would have a combination of breaking and non-breaking
changes, if possible make two releases: the non-breaking ones first,
and then a major release with the breaking ones.
This makes it possible for users who don't want the breaking changes
to still benefit from the non-breaking improvements.
* Before uploading to Hackage, check you have no changes to the files
(for example, temporarily changing the GHC options, or adding
``trace`` calls, for debugging reasons).
``stack upload`` will upload the files on the disk, not the files in
version control, so your unwanted changes will be published!