Release workflow

RELEASING.md

@@ -0,0 +1,53 @@
+# Versioning and release process
+
+## Release process
+
+### Changelog preparation
+The changelog preparation workflow is based on `cardano-updates` scripts.
+The full documentation for scripts is located at: https://github.com/input-output-hk/cardano-updates/blob/main/scripts/README.md
+This part requires the following tools installed:
+  * https://github.com/cli/cli
+  * https://jqlang.github.io/jq/
+  * https://mikefarah.gitbook.io/yq/
+
+1. Clone the `cardano-updates` repo (necessary only when doing it for the first time):
+    ```bash
+    git clone https://github.com/input-output-hk/cardano-updates
+    cd cardano-updates
+    ```
+1. Download all PRs from the `cardano-api` repo.
+  This will take some time if the number of all PRs is large.
+    ```bash
+    ./scripts/download-prs.sh input-output-hk/cardano-api
+    ```
+1. Process just downloaded PRs data by splitting it into separate data files related to separate repo components.
+  From each of those files, one changelog file will be generated.
+  Each data file will be placed into `gen/input-output-hk/cardano-api/detail`.
+  Data files can be modified to exclude the PR from the changelogs for example.
+  This can be done by setting its `included` field value to `false`.
+    ```bash
+    ./scripts/distribute-merged-prs.sh input-output-hk/cardano-api . 2023-01-01 2023-06-01
+    ```
+1. Generate changelogs for the data files in `gen/input-output-hk/cardano-api/summary` subdirectory:
+    ```bash
+    ./scripts/summarise-merged-prs.sh input-output-hk/cardano-api .
+    ```
+---
+
+from cardano-haskell-packages
+```bash
+./scripts/add-from-github.sh https://github.com/input-output-hk/cardano-api <git-hash>
+```
+
+for pushing cardano package e.g.
+```bash
+./scripts/add-from-github.sh https://github.com/input-output-hk/cardano-api <git-hash> cardano-api-gen
+```
+
+This is how I've been doing the release:
+
+1. Ensure CHANGELOG.md is updated and the version in the cabal file is updated, and those are in main.
+1. Run ./scripts/tag.sh to add and push the appropriate tag
+1. Update CHaP.
+
+The process I use is a little bit more than that in that I use scripts to pull change log entries and then past those in the CHANGELOG.md file, but you can skip that if your release has only one PR in it. (edited)