Skip to content

Commit

Permalink
docs: add PUBLISHING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
halildurmus committed Nov 14, 2024
1 parent f3e3a41 commit 370216a
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 🚀 Publishing a New Release

Follow these steps to publish a new release of the package:

## 1️⃣ Trigger the **Prepare Release** Workflow

Go to the [GitHub Actions] tab and trigger the [Prepare Release] workflow.

This workflow will:

- 🔄 **Remove** the `-wip` suffix from the version number in the `pubspec.yaml`
file _(e.g., `6.1.0-wip` ➡️ `6.1.0`)_
- 📝 **Update** the `CHANGELOG.md` file:
- Replace `## unreleased` with the new version number and today’s date
_(e.g., `## unreleased` ➡️ `## [6.1.0] - 2025-06-15`)_

After making these changes, the workflow will create a pull request (PR)
_(e.g., **`chore(release): v6.1.0`**)_.

## 2️⃣ Review and Merge the PR

Open the PR created by the workflow, review the changes, and **merge it** into
the main branch.

## 3️⃣ Automatic Publishing

Once the PR is merged:

- The [Publish] workflow will be triggered automatically.
- This workflow will:
- 📦 **Create** a new release on GitHub with a corresponding Git tag.
- 🚀 **Publish** the new package version to [pub.dev].

[GitHub Actions]: https://github.com/halildurmus/win32_runner/actions
[Prepare Release]: https://github.com/halildurmus/win32_runner/blob/main/.github/workflows/prepare_release.yml
[Publish]: https://github.com/halildurmus/win32_runner/blob/main/.github/workflows/publish.yml
[pub.dev]: https://pub.dev

0 comments on commit 370216a

Please # to comment.