From b32f8927a9e9250b8e4583bf29e7bccec5e0025b Mon Sep 17 00:00:00 2001 From: Ellet Date: Sun, 19 May 2024 23:15:22 +0300 Subject: [PATCH] docs: update the development notes to reflect the new changes --- doc/development_notes.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/development_notes.md b/doc/development_notes.md index 4e9d649f..00ff587a 100644 --- a/doc/development_notes.md +++ b/doc/development_notes.md @@ -2,7 +2,9 @@ - When updating the translations or localizations in the app, please take a look at the [Translation](./translation.md) page as it has important notes in order to work, if you also add a feature that adds new localizations then you need to the instructions of it in order for the translations to take effect - We use the same package version and `CHANGELOG.md` for all the packages, for more [details](https://github.com/singerdmx/flutter-quill/pull/1878), the process is automated. We have a script that will do the followings: - 1. Copy the contents of the root `CHANGELOG.md` file into all the `CHANGELOG.md` of the packages (overwrite), you need to mention the changes of all the packages in the `CHANGELOG.md` of the root folder as it will be copied, we still have to mention the new changes in the `CHANGELOG.md` and update it as it's not automated yet. + 1. Generate the `CHANGELOG.md` files by `CHANGELOG.json` (source of data) and then paste them into all the packages we have (overwrite), you don't need to + manually change/update any of the mentioned files above, once a new GitHub release published, the CI will take the release notes from the release, pass the info to the + script, the release notes can be auto-generated by Github using a button, a descirptive PRs title would help but you don't have to since we can change it at anytime. 2. The script require the new version as an argument, you don't need to run the script manually, when a maintainer create a new tag and publish a new GitHub release, the publish workflow will extract the new version from the tag name, run the script (pass the extracted version as an argument), commit the changes and push them into the repository, the script will update the `version` property for all the packages so the `flutter pub publish` will use the new version for each package correctly. the script will be used the CI and no need to run it manually \ No newline at end of file