fix: truncate api names for old versions #405
Merged
Conversation
This file contains 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
jgresty
reviewed
Jan 29, 2025
RaduPetreTarean
force-pushed
the
fix/truncate-api-names-before-pivot
branch
2 times, most recently
from
79ff8f4 to
d249491
Compare
jgresty
reviewed
Feb 3, 2025
internal/backstage/backstage.go
Outdated
| availableTitleLen = 0 | ||
| } | ||
| name = fmt.Sprintf("%."+strconv.Itoa(availableTitleLen)+"s%s%s", | ||
| toBackstageName(doc.Info.Title), name_suffix, stabilitySuffix) |
There was a problem hiding this comment.
If we are building the name from scratch again here then doing it above is redundant. You can remove the logic on line ~279.
Please also make sure you retain the comment that explains why we are doing this.
RaduPetreTarean
force-pushed
the
fix/truncate-api-names-before-pivot
branch
from
d249491 to
f160c5d
Compare
We append the stability of apis before the pivot date This is made after the truncation to 63 characters Which results in invalid names if api names are too long This truncates the name back to 63 characters
RaduPetreTarean
force-pushed
the
fix/truncate-api-names-before-pivot
branch
from
f160c5d to
60d244b
Compare
jgresty
approved these changes
Feb 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We previously appended the stability of apis before the pivot date, this is made after the truncation to 63 characters.
Which results in invalid names if api names are too long, this truncates the name back to 63 characters