docs: clarify release steps in CONTRIBUTING.md

[ttypic]

Clarify release steps in CONTRIBUTING.md

Summary by CodeRabbit

• Documentation
  • Updated contribution guidelines: normalized release step numbering, reordered publishing steps, and added two new release actions for requesting approval to publish and updating the public changelog.
  • Clarified changelog guidance: keep generator instructions and advise replacing autogenerated HEAD links with the new version tag; preserved examples and manual workflow notes.

[coderabbitai]

Walkthrough

Updated CONTRIBUTING.md: corrected release step numbering/formatting, removed a stray list marker, reordered and renumbered post-merge release actions, removed flutter pub publish from the numbered list, added a workflow approval step for publishing to pub.dev, and added a Headway changelog update step plus guidance to replace HEAD with the new version tag in autogenerated changelog URLs.

Changes

Cohort / File(s)	Summary
Contributing documentation CONTRIBUTING.md	Fixed stray list marker and step formatting; reordered and renumbered post-merge release steps (removed flutter pub publish from numbered steps); added a Release Workflow approval step for publishing to pub.dev; added updating the Ably changelog via Headway; kept changelog generator instructions and added note to replace HEAD with the new version tag in autogenerated URLs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through lines, made numbers align,

A gentle tug on tags, a tidy new sign,
Approval requested, changelog updated with care,
I buried stray bullets — now releases are fair,
Sniff, nibble, push — celebrate with a carrot and a hare 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and accurately summarizes the main change: clarifying release steps documentation in CONTRIBUTING.md, which aligns with the actual modifications made.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch update-release-process

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

CONTRIBUTING.md (1)

201-205: Clarify that pub.dev publishing is now automated via Release Workflow.

The restructured release process (steps 10–14) removes the manual flutter pub publish step and introduces automated publishing through the Release Workflow (step 13). While this is a good practice, the documentation should explicitly state that pub.dev publication is now delegated to the CI/CD workflow rather than run manually. This will help maintainers understand the flow and avoid duplicate publication attempts.

Consider adding a clarifying note before step 10, such as:

+After the release PR is landed:
+
 10. Create a tag named like `v1.2.3`, using `git tag v1.2.3`

This makes it clear that the next phase shifts from PR approval to automated release tasks.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between aca05b9 and e2c6920.

📒 Files selected for processing (1)

• CONTRIBUTING.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

CONTRIBUTING.md

[uncategorized] ~191-~191: The official name of this software platform is spelled with a capital “H”.
Context: ...ntegration/ios - Commit this 4. Run [github_changelog_generator`](https://github.co...

(GITHUB)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: android
• GitHub Check: ios
• GitHub Check: android (24)
• GitHub Check: ios
• GitHub Check: android (29)

🔇 Additional comments (1)

CONTRIBUTING.md (1)

191-195: Approve added guidance for URL replacement.

The new instruction at line 195 to replace HEAD in autogenerated URLs with the actual version tag (e.g., v1.2.3) is helpful and removes ambiguity. This clarification improves the release process documentation.

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

CONTRIBUTING.md (1)

203-203: ⚠️ Potential issue | 🟡 Minor

Fix malformed markdown link syntax.

The link contains double opening parentheses ]((https://...)) and should be ](https://...).

🔧 Proposed fix

-12. Create a release on GitHub following the [previous releases]((https://github.com/ably/ably-flutter/releases)) as examples.
+12. Create a release on GitHub following the [previous releases](https://github.com/ably/ably-flutter/releases) as examples.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` at line 203, The markdown link in the CONTRIBUTING.md line
"Create a release on GitHub following the [previous
releases]((https://github.com/ably/ably-flutter/releases)) as examples." is
malformed due to double opening parentheses; replace the sequence
"]((https://github.com/ably/ably-flutter/releases))" with the correct markdown
link form "](https://github.com/ably/ably-flutter/releases)" so the "previous
releases" anchor links properly.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 204: Update the sentence in CONTRIBUTING.md that currently reads "ask
[ably/team-sdk](https://github.com/orgs/ably/teams/team-sdk) member to approve"
to include the missing article by changing it to "ask an
[ably/team-sdk](https://github.com/orgs/ably/teams/team-sdk) member to approve",
ensuring the rest of the Release Workflow line remains unchanged.

---

Duplicate comments:
In `@CONTRIBUTING.md`:
- Line 203: The markdown link in the CONTRIBUTING.md line "Create a release on
GitHub following the [previous
releases]((https://github.com/ably/ably-flutter/releases)) as examples." is
malformed due to double opening parentheses; replace the sequence
"]((https://github.com/ably/ably-flutter/releases))" with the correct markdown
link form "](https://github.com/ably/ably-flutter/releases)" so the "previous
releases" anchor links properly.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 03dd1c81-56a8-4f5a-b15f-911b9bc017e1

📥 Commits

Reviewing files that changed from the base of the PR and between 3006413 and 2952784.

📒 Files selected for processing (1)

• CONTRIBUTING.md