TT-17973: Render the public retired-versions table from the plan - #546
Merged
Conversation
olamilekan000
force-pushed
the
TT-17973-retired-versions-snippet
branch
from
September 2, 2026 16:23
2748fb1 to
484d35f
Compare
olamilekan000
changed the title
olamilekan000
force-pushed
the
TT-17973-retired-versions-snippet
branch
2 times, most recently
from
September 2, 2026 16:27
00327ab to
6bad499
Compare
rafalgolarz
reviewed
Sep 3, 2026
| "golang.org/x/mod/semver" | ||
| ) | ||
|
|
||
| var productNames = map[string]string{ |
Contributor
There was a problem hiding this comment.
I think this list should be in the config file.
Contributor
Author
There was a problem hiding this comment.
I don't think it needs a config file. These are just more constants. and besides, gromit doesn't have a config file.
Contributor
There was a problem hiding this comment.
are you sure it does not have a config file?
https://github.com/TykTechnologies/gromit/blob/master/config/config.yaml
I still believe hard-coding is something we should avoid.
rafalgolarz
requested changes
Sep 3, 2026
rafalgolarz
requested changes
Sep 3, 2026
| "golang.org/x/mod/semver" | ||
| ) | ||
|
|
||
| var productNames = map[string]string{ |
Contributor
There was a problem hiding this comment.
are you sure it does not have a config file?
https://github.com/TykTechnologies/gromit/blob/master/config/config.yaml
I still believe hard-coding is something we should avoid.
The pkgs retirement subcommand turns the committed retention plan into the retired-versions snippet published on tyk.io, and the retention plan workflow PRs it to tyk-docs whenever the table changes. Rendering from the plan rather than recomputing guarantees the published table matches what pruning will enforce. The hand-written first draft of the table proved the point: it said 5.8.x where the derived cutoff is actually 5.5.x, because the EE window keeps three released series below the previous LTS.
olamilekan000
force-pushed
the
TT-17973-retired-versions-snippet
branch
from
September 3, 2026 09:38
6bad499 to
c40bf26
Compare
rafalgolarz
approved these changes
Sep 3, 2026
olamilekan000
enabled auto-merge (squash)
September 3, 2026 11:27
olamilekan000
disabled auto-merge
September 4, 2026 10:37
olamilekan000
enabled auto-merge (squash)
September 4, 2026 10:38
olamilekan000
disabled auto-merge
September 4, 2026 10:38
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds
gromit pkgs retirement, which renders the retired-versions table published on the tyk.io retention policy page from a committed retention plan, and extends theRetention plan noticeworkflow to PR the updated snippet totyk-docswhenever the table changes (no changes → no PR).The table is rendered from the committed
plan.json— which already carries the derived cutoff per repo — rather than recomputed, so the published table can never disagree with what pruning will enforce. Only track-driven repos appear, since their windows are what the public policy describes. The hand-written first draft of the table showed why this matters: it said 5.8.x where the derived cutoff is actually 5.5.x (the EE window retains three released series below the previous LTS).Jira Ticket: TT-17973
Type of Change
Verification & Testing
go test ./pkgs/... ./cmd/...) and they passed.go run . policy gen) and verified the rendered files. (n/a — no template changes)tyk,tyk-analytics). (ran the command against the committed September plan; its output is byte-identical to the snippet on thetyk-docsretention page branch, so the first automated sync is a no-op)Command(s) used for testing:
Checklist