chore: add release ready script (#315)

* chore: add release ready

* docs

Author: renancaraujo

CONTRIBUTING.md

@@ -121,3 +121,30 @@ dart analyze --fatal-infos --fatal-warnings .
 9. Verify that all [status checks](https://github.com/VeryGoodOpenSource/very_good_core/actions/) are passing for your Pull Request once they have been approved to run by a maintainer.
 
 💡 **Note**: While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional work, tests, or other changes before your pull request can be accepted.
+
+
+## Releasing a new version
+
+1. Ensure your local `main` branch is up to date with the remote `main` branch:
+
+```sh
+git checkout main
+git pull origin main
+git status
+```
+
+2. Ensure the current pipeline is passing on the `main` branch, [here](https://github.com/VeryGoodOpenSource/very_good_core/actions/workflows/very_good_core.yaml?query=branch%3Amain).
+
+3. From the repository, run the script to release a new version:
+
+```sh
+./tool/release_ready.sh <new-version>
+
+git commit -m "chore: v<new-version>"
+```
+
+This script will:
+- Create a new branch named `chore/v<new-version>`
+- Update the version info on `brick/brick.yaml`
+- Update the version info on `brick/CHANGELOG.md`
+- Then commit those changes with the message `chore: v<new-version>`

tool/release_ready.sh

@@ -0,0 +1,79 @@
+# Ensures that the package or brick is ready for a release.
+#
+# Set it up for a new version:
+# `./release_ready.sh <version>
+
+# Check if current directory is usable for this script, if so we assume it is correctly set up.
+if [ ! -f "brick/brick.yaml" ]; then
+  echo "$(pwd) is not a valid brick."
+  exit 1
+fi
+
+currentBranch=$(git symbolic-ref --short -q HEAD)
+if [[ ! $currentBranch == "main" ]]; then
+  echo "Releasing is only supported on the main branch."
+  exit 1
+fi
+
+# Get information
+old_version=""
+current_name=""
+if [ -f "brick/brick.yaml" ]; then
+  old_version=$(cat brick/brick.yaml | pcregrep 'version: (.*?)' | tr " " "\n" | tail -1)
+  current_name=$(cat brick/brick.yaml | pcregrep 'name: (.*?)' | tr " " "\n" | tail -1)
+fi
+
+if [ -z "$old_version" ] || [ -z "$current_name" ]; then
+  echo "Current version or name was not resolved."
+  exit 1
+fi
+
+# Get new version
+new_version="$1";
+
+if [[ "$new_version" == "" ]]; then
+  echo "No new version supplied, please provide one"
+  exit 1
+fi
+
+if [[ "$new_version" == "$old_version" ]]; then
+  echo "Current version is $old_version, can't update."
+  exit 1
+fi
+
+# Retrieving all the commits in the current directory since the last tag.
+previousTag="v${old_version}"
+raw_commits="$(git log --pretty=format:"%s" --no-merges --reverse $previousTag..HEAD -- .)"
+markdown_commits=$(echo "$raw_commits" | sed -En "s/\(#([0-9]+)\)/([#\1](https:\/\/github.com\/VeryGoodOpenSource\/very_good_core\/pull\/\1))/p")
+
+if [[ "$markdown_commits" == "" ]]; then
+  echo "No commits since last tag, can't update."
+  exit 0
+fi
+commits=$(echo "$markdown_commits" | sed -En "s/^/- /p")
+
+echo "Updating version to $new_version"
+if [ -f "brick/brick.yaml" ]; then
+  sed -i '' "s/version: $old_version/version: $new_version/g" brick/brick.yaml
+fi
+
+# Update dart file with new version.
+dart run build_runner build --delete-conflicting-outputs > /dev/null
+
+if grep -q $new_version "brick/CHANGELOG.md"; then
+  echo "CHANGELOG already contains version $new_version."
+  exit 1
+fi
+
+# Add a new version entry with the found commits to the brick/CHANGELOG.md.
+echo "# ${new_version}\n\n${commits}\n\n$(cat brick/CHANGELOG.md)" > brick/CHANGELOG.md
+echo "CHANGELOG for $current_name generated, validate entries here: $(pwd)/brick/CHANGELOG.md"
+
+echo "Creating git branch for $current_name@$new_version"
+git checkout -b "chore/v$new_version" > /dev/null
+
+git add brick/brick.yaml brick/CHANGELOG.md
+
+echo ""
+echo "Run the following command if you wish to commit the changes:"
+echo "git commit -m \"chore: v$new_version\""