Skip to content

Commit

Permalink
Mention test_branch in HACKING.org (#1339)
Browse files Browse the repository at this point in the history
* Mention test_branch in HACKING.org

This can be useful for external contributors or to have a support for discussion.

* Mention that diffs should be discussed before continuing

* Mention releases should be announced
  • Loading branch information
Julow authored Apr 24, 2020
1 parent 6fb5a8c commit 42ac795
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions HACKING.org
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
* Testing on other projects

The =tools/test_branch.sh= script builds 2 revisions of OCamlformat and run them
on the sources of some projects.
The list of tested project is (and can be edited) in =test-extra/Makefile=.

The projects sources are cloned into =test-extra/code=.
Git is used to manage the script's state:
- staged changes are the diffs introduced by formatting with the first revision
- unstaged changes are the diffs introduced by upgrading OCamlformat to the
second rev

* Release procedure

- Review the impact of the release on real source code:
In =test-extra/Makefile=, uncomment the extended list of projects to test
and run =tools/test_branch.sh -a "previous_release"=.
Diffs should be discussed with the maintainers of these projects to gather
feedback before continuing the release.

- In =CHANGES.md=, change =(unreleased)= with the current date
Commit

Expand All @@ -17,3 +35,5 @@
- Release on Opam-repository
=dune-release opam pkg=
=dune-release opam submit=

- Each release should be announced on [[https://discuss.ocaml.org/]]

0 comments on commit 42ac795

Please sign in to comment.