feat!: release version 11.0.0 with breaking changes

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,6 @@
 <!-- 
-
-Thank you for contributing.
-
-Provide a description of your changes below and a general summary in the title.
-
+Thank you for contributing. Provide a description of your changes below and a general summary in the title.
 Consider reading the Contributor Guide: https://github.com/singerdmx/flutter-quill/blob/master/CONTRIBUTING.md.
-
-The changes of `CHANGELOG.md` and package version in `pubspec.yaml` are automated.
-
 -->
 
 ## Description
@@ -17,23 +10,20 @@ The changes of `CHANGELOG.md` and package version in `pubspec.yaml` are automate
 ## Related Issues
 
 <!--
-
 Replace this paragraph with a list of issues related to this PR from the [issue database](https://github.com/singerdmx/flutter-quill/issues). Indicate, which of these issues are resolved or fixed by this PR.
-
 -->
 
-<!-- *e.g.* -->
+<!-- *e.g.*
 - *Fix #123*
 - *Related #456*
+-->
 
 ## Type of Change
 
-<!--- 
-
-Put an x in all the boxes that apply:
-
-- [x] **Example:**
-
+<!---
+Check the boxes that apply with x and leave the others empty. For example:
+- [ ] ✨ **New feature:** Adds new functionality without breaking existing features.
+- [x] 🛠️ **Bug fix:** Resolves an issue without changing current behavior.
 -->
 
 - [ ] ✨ **New feature:** Adds new functionality without breaking existing features.
@@ -44,7 +34,3 @@ Put an x in all the boxes that apply:
 - [ ] 📝 **Documentation:** Updates or additions to documentation.
 - [ ] 🗑️ **Chore:** Routine tasks, or maintenance.
 - [ ] ✅ **Build configuration change:** Changes to build or deploy processes.
-
-## Suggestions
-
-<!-- Optional -->

.github/workflows/changelog.yml

@@ -0,0 +1,19 @@
+name: 📝 Changelog File Check
+
+# This workflow only validates if the CHANGELOG.md file was updated and doesn't validate the format.
+
+on:
+  pull_request:
+    types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
+    branches:
+      - master
+
+jobs:
+  changelog:
+    name: 🔍 Verify Changelog Modification
+    runs-on: ubuntu-latest
+    steps:
+      - name: ✅ Check if CHANGELOG.md was modified
+        uses: tarides/changelog-check-action@v2
+        with:
+          changelog: CHANGELOG.md

.github/workflows/gh_release_notes.yml

@@ -0,0 +1,29 @@
+name: 🚀 Update GitHub Release Notes from CHANGELOG.md
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release-notes:
+    name: 📝 Publish Release Notes from Changelog
+    permissions:
+      # Required for updating GitHub release notes
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📦 Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: ✂️ Extract Release Notes from CHANGELOG.md
+        id: extract-release-notes
+        uses: ffurrer2/extract-release-notes@v2
+        with:
+          changelog_file: CHANGELOG.md
+
+      - name: 🖋️ Update Release Notes
+        uses: irongut/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          id: ${{ github.event.release.id }}
+          body: ${{ steps.extract-release-notes.outputs.release_notes }}

.github/workflows/main.yml

@@ -1,5 +1,7 @@
 name: 🧪 Run Tests
 
+# TODO: Split the tests into tests.yml and quality checks into checks.yml once start using https://pub.dev/packages/melos
+
 on:
   push:
     branches: [master, dev]
@@ -49,4 +51,11 @@ jobs:
         run: flutter test
 
       - name: 🔍 Check the translations
-        run: dart ./scripts/ensure_translations_correct.dart
+        run: dart ./scripts/translations_check.dart
+
+      - name: 📥 Install cider
+        run: dart pub global activate cider
+
+      # TODO: Need a more strict way to validate the format that uses https://keepachangelog.com/en/1.1.0/
+      - name: 🔍 Validate CHANGELOG.md format
+        run: $HOME/.pub-cache/bin/cider list CHANGELOG.md

.github/workflows/publish.yml

@@ -1,27 +1,24 @@
 name: 🚀 Publish to pub.dev
 
+# Note: This workflow only publishes flutter_quill package, the flutter_quill_extensions 
+# need to be manually published.
+
 on:
   push:
     tags:
     - 'v[0-9]+.[0-9]+.[0-9]+*'
 
 jobs:
   publish:
-    name: Publish the packages
+    name: Publish the flutter_quill package
     permissions:
       id-token: write
-      # Give the default GITHUB_TOKEN write permission to commit and push the changed files to the repository.
-      # Also required for uploading files to the Release assets
+      # Required for uploading files to the release assets of GitHub.
       contents: write
     runs-on: ubuntu-latest
     steps:
       - name: 📦 Checkout repository
         uses: actions/checkout@v4
-        # Needed for commit and push changes
-        with:
-          # TODO: Try to not hardcode the branch name
-          ref: master
-          fetch-depth: 0 # To get all tags
 
       - name: 📄 Upload LICENSE file to release assets
         uses: softprops/action-gh-release@v2
@@ -50,8 +47,6 @@ jobs:
       # - name: Update the authorization requests to "https://pub.dev" to use the environment variable "PUB_TOKEN".
       #   run: dart pub token add https://pub.dev --env-var PUB_TOKEN
 
-      # Before publishing the new packages, update the version for all the packages first
-
       # Extract version from the tag (handles the 'v' prefix)
       - name: 🏷️ Extract version from tag as pubspec.yaml version
         id: extract_version
@@ -71,33 +66,41 @@ jobs:
         id: release_tag
         run: echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
 
-      - name: 📑 Fetch release notes from Github API and create a required file by the next step
-        run: dart ./scripts/create_version_content_from_github_release.dart "${{ github.repository }}" "${{ steps.release_tag.outputs.tag }}"
+      # TODO: Validate the tag, the version must match the one in pubspec.yaml, publishing the package will throw an error
+
+      # TODO: Might automate some changes of the CHANGELOG.md (outdated TODO)
+
+      - name: 📝 Update package version in pubspec.yaml
+        run: dart ./update_pubspec_version.dart ./pubspec.yaml ${{ steps.extract_version.outputs.VERSION }}
+
+      # - name: 📝 Update CHANGELOG.md to reflect the change
+      #   uses: thomaseizinger/keep-a-changelog-new-release@v2
+      #   with:
+      #     tag: ${{ steps.release_tag.outputs.tag }}
+      #     changelogPath: ./CHANGELOG.md
+
+      - name: 📝 Update CHANGELOG.md to reflect the change
+        run: dart ./update_changelog_version.dart ./CHANGELOG.md ${{ steps.extract_version.outputs.VERSION }}
+
+      - name: 📄 Print updated pubspec.yaml
+        run: |
+          echo "===== 📜 pubspec.yaml ====="
+          cat pubspec.yaml | tee /dev/stderr
+          echo "==========================="
 
-      - name: 📝 Update version and CHANGELOG for all the packages
-        run: dart ./scripts/update_package_version.dart ${{ steps.extract_version.outputs.VERSION }}
+      - name: 📝 Print updated CHANGELOG.md
+        run: |
+          echo "===== 📝 CHANGELOG.md ====="
+          cat CHANGELOG.md | tee /dev/stderr
+          echo "==========================="
 
       - name: 💾 Commit updated version and CHANGELOG
-        id: auto-commit-action
-        uses: stefanzweifel/git-auto-commit-action@v5
+        uses: EndBug/add-and-commit@v9
         with:
-          commit_message: "chore(version): update to version ${{ steps.extract_version.outputs.VERSION }}"
-
-      - name: 🔍 Verify changes made by the script
-        if: steps.auto-commit-action.outputs.changes_detected == 'true'
-        run: echo "✅ Changes have been committed."
+          message: "chore(release): prepare to publish ${{ steps.extract_version.outputs.VERSION }}"
 
       - name: 🔄 Check if package is ready for publishing
         run: flutter pub publish --dry-run
 
       - name: 📤 Publish flutter_quill
         run: flutter pub publish --force
-
-      - name: 📤 Publish flutter_quill_extensions
-        run: flutter pub publish --force
-        working-directory: ./flutter_quill_extensions/
-
-      - name: 📤 Publish flutter_quill_test
-        run: flutter pub publish --force
-        working-directory: ./flutter_quill_test/
-

.gitignore

@@ -75,4 +75,5 @@ example/ios/Podfile.lock
 !**/ios/**/default.mode2v3
 !**/ios/**/default.pbxuser
 !**/ios/**/default.perspectivev3
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspec-lock.
 pubspec.lock