Skip to content

[#2731] Documented tagging 'drevops/vortex-tooling' before each Vortex release.#2734

Merged
AlexSkrypnyk merged 3 commits into
mainfrom
feature/2731-tag-tooling-release
Jun 26, 2026
Merged

[#2731] Documented tagging 'drevops/vortex-tooling' before each Vortex release.#2734
AlexSkrypnyk merged 3 commits into
mainfrom
feature/2731-tag-tooling-release

Conversation

@AlexSkrypnyk

Copy link
Copy Markdown
Member

Closes #2731

Summary

The release procedure for Vortex did not define any relationship between drevops/vortex-tooling tags and Vortex releases, leaving the tooling dependency free to float onto unpublished or future minor versions after a release was cut. This change documents the required tagging order (tooling first when changed, then Vortex), the tilde-constraint rule for pinning the tooling version in composer.json, and adds the corresponding checklist items to the release template so the steps are not missed during a release.

Changes

.vortex/docs/content/contributing/maintenance/release.mdx

  • Added a new ## Tagging policy section above the Release Process that defines four rules: Vortex is always tagged; the tooling is always referenced by a published tag (never a branch); the tooling is tagged before Vortex when it changed; Vortex caps its tooling requirement at the freshly tagged version using a tilde constraint.
  • Renumbered the Release Process steps (old 6-11 became 7-12) to insert step 6 ("Tag drevops/vortex-tooling first when it changed") and step 7 now also instructs the releaser to apply the tilde-constrained tooling version in composer.json when a new tooling tag was created.
  • Step 12 (was 11) now explicitly states that Vortex is always tagged and, when the tooling changed, its tag must be created first.

.vortex/docs/content/contributing/maintenance/_release_template.md

  • Added checklist item: "Tagged drevops/vortex-tooling before the Vortex tag when the tooling changed, and pinned the freshly tagged version as the upper boundary in composer.json."
  • Added checklist item: "Tagged the Vortex release."

Before / After

BEFORE
┌─────────────────────────────────────────────────────────────┐
│ Release Process                                             │
│                                                             │
│  Step 6: composer update -W && composer bump                │
│           (tooling constraint: floating, no upper bound)    │
│  Step 11: Create GitHub release                             │
│                                                             │
│  No tooling tag step                                        │
│  No ordering between tooling and Vortex tags                │
│  composer.json may reference a branch or float              │
└─────────────────────────────────────────────────────────────┘

AFTER
┌─────────────────────────────────────────────────────────────┐
│ Tagging policy (new section)                                │
│  1. Vortex is always tagged.                                │
│  2. Tooling is always referenced by a published tag.        │
│  3. Tooling is tagged before Vortex when it changed.        │
│  4. Vortex caps tooling at the tagged minor (~1.3.0).       │
│                                                             │
│ Release Process                                             │
│  Step 6: Tag drevops/vortex-tooling first (if changed)      │
│  Step 7: composer bump + pin tooling with tilde constraint  │
│  Step 12: Tag Vortex (tooling tag already published)        │
│                                                             │
│  Order enforced: tooling tag -> composer pin -> Vortex tag  │
└─────────────────────────────────────────────────────────────┘

@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@AlexSkrypnyk, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 29 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 6bb8b4a7-98f0-4351-8ab5-4f26873cf478

📥 Commits

Reviewing files that changed from the base of the PR and between 7ca9e01 and dfff16a.

📒 Files selected for processing (2)
  • .vortex/docs/content/contributing/maintenance/_release_template.md
  • .vortex/docs/content/contributing/maintenance/release.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/2731-tag-tooling-release

Comment @coderabbitai help to get the list of available commands.

@AlexSkrypnyk AlexSkrypnyk added this to the 1.40.0 milestone Jun 25, 2026
@AlexSkrypnyk AlexSkrypnyk added the A2 Working clone index A2 label Jun 25, 2026
@AlexSkrypnyk

This comment has been minimized.

@github-actions

Copy link
Copy Markdown

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   98.55% (204/207)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@AlexSkrypnyk

This comment has been minimized.

1 similar comment
@AlexSkrypnyk

Copy link
Copy Markdown
Member Author

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   98.55% (204/207)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@github-actions

Copy link
Copy Markdown

📖 Documentation preview for this pull request has been deployed to Netlify:

https://6a3dc3bec05b06c1613df5fd--vortex-docs.netlify.app

This preview is rebuilt on every commit and is not the production documentation site.

@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.22%. Comparing base (7ca9e01) to head (dfff16a).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2734      +/-   ##
==========================================
- Coverage   86.67%   86.22%   -0.45%     
==========================================
  Files          96       89       -7     
  Lines        4719     4560     -159     
  Branches       47        3      -44     
==========================================
- Hits         4090     3932     -158     
+ Misses        629      628       -1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlexSkrypnyk AlexSkrypnyk added the Needs review Pull request needs a review from assigned developers label Jun 26, 2026
@AlexSkrypnyk AlexSkrypnyk merged commit 0a88160 into main Jun 26, 2026
34 checks passed
@AlexSkrypnyk AlexSkrypnyk deleted the feature/2731-tag-tooling-release branch June 26, 2026 00:20
@github-project-automation github-project-automation Bot moved this from BACKLOG to Release queue in Vortex 1.x Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A2 Working clone index A2 Needs review Pull request needs a review from assigned developers

Projects

Status: Release queue

Development

Successfully merging this pull request may close these issues.

Update release procedure to require tagging 'drevops/vortex-tooling' before each Vortex release

1 participant