From 2251a97f02a9e0936007bd8931c67008f434102d Mon Sep 17 00:00:00 2001 From: Gaith Hallak Date: Thu, 4 Aug 2022 16:25:11 +0400 Subject: [PATCH] Add a section about creating a new aesophia release --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b47b3b2..bc6ac72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,3 +22,17 @@ The following points should be considered before creating a new PR to the Sophia - If a PR introduces new syntax (e.g. changes in [aeso_syntax.erl](src/aeso_syntax.erl), [aeso_scan.erl](src/aeso_scan.erl), or [aeso_parser.erl](src/aeso_parser.erl)), the following code should be updated to handle the new syntax: - The function `aeso_syntax_utils:fold/4` in the file [aeso_syntax_utils.erl](src/aeso_syntax_utils.erl). - Any related pretty printing function in the file [aeso_pretty.erl](src/aeso_pretty.erl), depending on the type of the newly added syntax. + +## Checklist For Creating a Release + +- Update the version in the file [aesophia.app.src](src/aesophia.app.src). +- Update the version in the file [rebar.config](rebar.config). +- In the [Changelog](CHANGELOG.md): + - Update the `Unreleased` changes to be under the new version. + - Update the version at the bottom of the file. +- Commit and the changes and create a new PR (check the commit of [v6.1.0](5ad5270e381f6e810d7b8b5cdc168d283e7a90bb) for reference). +- Create a release after merging the new PR to `master` branch. +- After releasing `aesophia`, refer to each of the following repositories and create new releases as well, using the new `aesophia` release: + - [aesophia_cli](https://github.com/aeternity/aesophia_cli) + - [aesophia_http](https://github.com/aeternity/aesophia_http) + - [aerepl](https://github.com/aeternity/aerepl)