Skip to content

docs: add release branching documentation#1516

Merged
kriswest merged 15 commits into
finos:mainfrom
jescalada:1483-release-branching-documentation
May 13, 2026
Merged

docs: add release branching documentation#1516
kriswest merged 15 commits into
finos:mainfrom
jescalada:1483-release-branching-documentation

Conversation

@jescalada
Copy link
Copy Markdown
Contributor

@jescalada jescalada commented May 1, 2026

Closes #1483.

The updated workflows have been added in #1520, all documentation here reflects the changes included in that PR.

We should decide which versions will be supported (with occasional bugfixes). I thought about supporting 1.20 and 2.x, and then dropping support for 1.20 when 3.0 comes out, but v1 has drifted so much from 2.0 that we'd be better off dropping support entirely to avoid all the extra work. Either way, this doc should be updated to inform users/maintainers about which GitProxy versions have active support.

Notes

  • I wrote this with the assumption that we'll be doing cascade-based merges rather than cherry-picking, as @coopernetes suggested in Enforce GitLabFlow branching strategy #1483
  • We might want to add a section to explain which versions will be supported, in order to limit the amount of extra work and merge conflicts when cascading bugfixes. For example, only the latest of each major version (currently 1.19 and 2.0)
  • I mentioned that releases are supposed to follow a cadence, but I never specified what that cadence should be. We should decide on an appropriate cadence (say, every three months) or remove that part entirely.

Would love to hear your thoughts! @finos/git-proxy-maintainers

@netlify
Copy link
Copy Markdown

netlify Bot commented May 1, 2026

👷 Deploy Preview for endearing-brigadeiros-63f9d0 processing.

Name Link
🔨 Latest commit 1491581
🔍 Latest deploy log https://app.netlify.com/projects/endearing-brigadeiros-63f9d0/deploys/69f4a1a99454630009da988c

@netlify
Copy link
Copy Markdown

netlify Bot commented May 1, 2026

Deploy Preview for endearing-brigadeiros-63f9d0 canceled.

Name Link
🔨 Latest commit 4bdb882
🔍 Latest deploy log https://app.netlify.com/projects/endearing-brigadeiros-63f9d0/deploys/6a042b9b8f2c80000841c2e2

@codecov
Copy link
Copy Markdown

codecov Bot commented May 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.21%. Comparing base (1d8adbb) to head (4bdb882).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1516   +/-   ##
=======================================
  Coverage   90.21%   90.21%           
=======================================
  Files          69       69           
  Lines        5511     5511           
  Branches      944      944           
=======================================
  Hits         4972     4972           
  Misses        521      521           
  Partials       18       18           

☔ View full report in Codecov by Sentry.
📢 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.

@jescalada jescalada marked this pull request as ready for review May 1, 2026 13:17
@jescalada jescalada requested a review from a team as a code owner May 1, 2026 13:17
Copy link
Copy Markdown
Contributor

@kriswest kriswest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - one thought on automatically checking alignment between package.json versions and branch name.

This could/should all be added to AI steering files - if an AI can pick up that a release is being prepared it can comment on the steps to be taken, merges to be performed and potentially help execute those steps correctly.

@re-vlad @jescalada

Comment thread docs/Releases.md
Comment thread docs/Releases.md Outdated
Comment thread docs/Releases.md
@jescalada jescalada requested a review from kriswest May 13, 2026 08:03
@jescalada
Copy link
Copy Markdown
Contributor Author

@kriswest Ready for another look 👍🏼

Copy link
Copy Markdown
Contributor

@kriswest kriswest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kriswest kriswest merged commit ad58c5a into finos:main May 13, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enforce GitLabFlow branching strategy

2 participants