update

Author: robmllze

.github/_README.md

@@ -1,36 +1,72 @@
-# Workflow for Managing Pub.dev Packages
+# pub.dev_package_workflow
+
+This repository provides a powerful and streamlined set of GitHub Actions workflows designed to automate the entire lifecycle of your Dart and Flutter packages—from version bumping and changelog generation to publishing on pub.dev and deploying examples to GitHub Pages.
+
+---
+
+## 🚀 Core Features
+
+- **Automated Version Bumping:** Automatically update `CHANGELOG.md`, `README.md`, and other files when you're ready to release.
+- **Git Tagging:** Automatically create and push Git tags for new versions.
+- **Flexible Publishing Triggers:** Publish packages automatically via special commit messages or by creating a release in the GitHub UI.
+- **Example App Deployment:** An optional workflow to build and deploy a Flutter web example to GitHub Pages.
 
 ## Workflows
 
-**This repository contains GitHub Actions workflows that simplify the management of your pub.dev packages:**
+This project contains three key GitHub Actions workflows.
+
+### 1. `process-package.yml`
+
+This is the primary workflow for managing releases directly from your commit messages. It triggers on every push to your `main` branch.
+
+- **Standard Commits:** For any normal commit message, the workflow does nothing.
+- **Prepare a Release (`+`):** If your commit message starts with a single plus sign (e.g., `+Added new feature`), the workflow will:
+    - Run `dart format` and `dart fix --apply`.
+    - Update your `CHANGELOG.md` with the commit message.
+    - Generate a standardized `README.md` from a central template.
+    - Commit these automated changes with the message `ci: bump version to v[version]`.
+    - Create and push a Git tag for the new version.
+- **Prepare and Publish (`++`):** If your commit message starts with two plus signs (e.g., `++Major performance improvements`), the workflow will do **everything above** and then automatically **publish the package to pub.dev** if properly configured. See https://dart.dev/tools/pub/automated-publishing.
+
+### 2. `publish.yml`
+
+This workflow provides a manual trigger for publishing. It activates **only** when you create a new release in the GitHub UI. This is perfect for when you want to review changes on the `main` branch before deciding to publish.
 
-- The `prepare.yaml` workflow triggers on every push to the main branch. It automatically updates the CHANGELOG.md, formats the Dart code, and applies Dart fixes with each push.
-- The `publish.yaml` workflow activates upon the creation of a new release, automatically handling the package's publication to pub.dev.
+### 3. `deploy-example.yml` (Optional)
 
-## Setup Instructions
+If your project contains a Flutter web example in a `hosted_example` directory, this workflow will automatically build it and deploy it to GitHub Pages on every push to the `main` branch. This is great for providing live demos of your package.
 
-**1. Navigate to your project:**
+---
+
+## 🛠️ Setup Instructions
+
+Setting up these workflows in your own package repository is simple.
+
+**1. Navigate to Your Project's Root Directory**
+
+Open your terminal and `cd` into the root of your Dart or Flutter package.
 
 ```zsh
-cd your_project
+cd /path/to/your_project
 ```
 
-**2. Clone this repo into a `.github/` folder:**
+**2. Clone this Workflow Repository**
+
+Clone this repository directly into a `.github` folder. This will create `.github/workflows` and `.github/scripts` for you.
 
 ```zsh
 git clone https://github.com/dev-cetera/pub.dev_package_workflow.git .github
 ```
 
-**3. Remove the `/.git` folder to include it to your project:**
+**3. Remove the Nested `.git` Directory**
 
-_On macOS and Linux:_
+To make these workflow files part of your own project's Git history, you must delete the nested `.git` directory that was just cloned.
 
-```zsh
-rm -rf .github/.git/
-```
+**4. Configure `pub.dev` for Automated Publishing**
 
-_On Windows:_
+For the `publish.yml` workflow to work, you must authorize GitHub Actions on `pub.dev`.
 
-```cmd
-rmdir /s /q .github/.git/
-```
+- Go to your package's page on `pub.dev` and click the **Admin** tab.
+- Under **Automated publishing**, click **Enable publishing from GitHub Actions**.
+- Set the **Repository** to your `username/repository_name`.
+- Set the **Tag pattern** to `v{{version}}`.

.github/scripts/update_changelog.dart

@@ -16,7 +16,7 @@ import 'dart:io';
 
 void main(List<String> args) {
   final version = args.isNotEmpty ? args[0] : '0.1.0';
-  final comitMesssage = args.length > 1 ? args[1].replaceFirst('+', '') : '';
+  final comitMesssage = args.length > 1 ? args[1].replaceFirst(RegExp(r'^\++'), '') : '';
   final changelogPath = 'CHANGELOG.md';
   final file = File(changelogPath);
   if (!file.existsSync()) {

.github/scripts/update_readme.dart

@@ -0,0 +1,58 @@
+//.title
+// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
+//
+// Dart/Flutter (DF) Packages by dev-cetera.com & contributors. The use of this
+// source code is governed by an MIT-style license described in the LICENSE
+// file located in this project's root directory.
+//
+// See: https://opensource.org/license/mit
+//
+// ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
+//.title~
+
+import 'dart:io';
+
+// ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
+
+void main(List<String> args) {
+  if (args.length < 3) {
+    print('Usage: dart run update_readme.dart <template_path> <package_name> <package_version>');
+    exit(1);
+  }
+
+  final templatePath = args[0];
+  final packageName = args[1];
+  final packageVersion = args[2];
+
+  // These paths are relative to where the script is run (the project root).
+  final localContentPath = '_README_CONTENT.md';
+  final finalReadmePath = 'README.md';
+
+  // --- 1. Load the master template file from the path provided by the CI ---
+  final templateFile = File(templatePath);
+  if (!templateFile.existsSync()) {
+    print('ERROR: Master README template not found at $templatePath');
+    exit(1);
+  }
+  final readmeTemplate = templateFile.readAsStringSync();
+
+  // --- 2. Load the local content file ---
+  final localContentFile = File(localContentPath);
+  if (!localContentFile.existsSync()) {
+    print('INFO: No _README_CONTENT.md found for $packageName. Cannot generate README.');
+    // Exit gracefully if there's no content to inject for this package.
+    exit(0);
+  }
+  final localReadmeContent = localContentFile.readAsStringSync();
+
+  // --- 3. Perform all replacements ---
+  var finalContent = readmeTemplate.replaceAll('{{{PACKAGE}}}', packageName);
+  finalContent = finalContent.replaceAll('{{{VERSION}}}', packageVersion);
+  finalContent = finalContent.replaceAll('{{{_README_CONTENT}}}', localReadmeContent);
+
+  // --- 4. Write the new README.md file ---
+  final finalReadmeFile = File(finalReadmePath);
+  finalReadmeFile.writeAsStringSync(finalContent);
+
+  print('SUCCESS: README.md for $packageName v$packageVersion has been updated.');
+}

.github/workflows/deploy.yml_REMOVE_TO_ENABLE renamed to .github/workflows/deploy-examplet.yml_REMOVE_TO_ENABLE

@@ -10,7 +10,7 @@
 ## ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
 ##.title~
 
-name: Deploy hosted_example to GitHub Pages
+name: Deploy Example on Commit
 
 ## -----------------------------------------------------------------------------