Skip to content

Commit

Permalink
docs: update PUBLISHING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
halildurmus committed Nov 15, 2024
1 parent 865d9ec commit 18420d6
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 50 deletions.
37 changes: 0 additions & 37 deletions PUBLISHING.md

This file was deleted.

44 changes: 31 additions & 13 deletions packages/win32/PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,37 @@
# Publishing a new release
# 🚀 Publishing a New Release

When it's time to publish a new release, follow these steps:
Follow these steps to publish a new release of the package:

1. Update the version numbers in the `CHANGELOG.md` and `pubspec.yaml` files
(e.g., `5.3.0-wip` -> `5.3.0`).
## 1️⃣ Trigger the **Prepare Release** Workflow

2. Create a commit with the message "Prepare for release v**x.y.z**", replacing
`x.y.z` with the new version number (e.g., `5.3.0`).
Go to the [GitHub Actions] tab and trigger the [Prepare Release] workflow.

3. Create a pull request (PR) with the commit and get it reviewed and merged.
This workflow will:

4. Create a new release on GitHub by following the link provided in the
**Publish tag** from the **Package publishing** comment on the PR. This link
will pre-fill the release information with the correct tag and changelog
entry.
- 🔄 **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`)_

Once the release is created on GitHub, the publish action will be triggered and
the new version of the package will be published to [pub.dev](https://pub.dev).
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/actions
[Prepare Release]: https://github.com/halildurmus/win32/blob/main/.github/workflows/prepare_release.yml
[Publish]: https://github.com/halildurmus/win32/blob/main/.github/workflows/publish.yml
[pub.dev]: https://pub.dev

0 comments on commit 18420d6

Please sign in to comment.