Repository navigation
feat(route-tls)!: require explicit route_name input - #144
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Composite actions do not enforce required: true, so an omitted or empty route_name still triggers the legacy fallback and preserves the route conflict this change is intended to prevent.
1 open issue
What changed in this PR
This PR makes explicit Route naming part of the route-tls action’s declared contract, helping callers target existing OpenShift Routes rather than assume a generated name.
Changes:
- Marks
route_nameas required and removes its metadata default. - Updates usage documentation and migration guidance.
- Supplies explicit Route names in both PR dry-run steps.
| File | Description |
|---|---|
route-tls/README.md |
Updates the usage example and Route naming guidance. |
route-tls/action.yml |
Declares route_name required without a default. |
AGENTS.md |
Adds guidance for selecting existing and new Route names. |
.github/workflows/pr-open.yml |
Passes explicit Route names in dry-run calls. |
Review effort: Balanced
| required: false | ||
| default: ${{ github.event.repository.name }}-vanity-url | ||
| description: "OpenShift Route name (e.g. <repository>-prod-frontend-vanity or <repository>-vanity-url)." | ||
| required: true |
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
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.
Defaulting route_name to -vanity-url leads callers to omit the input and fail against existing OpenShift routes named -prod-frontend-vanity.
Changes
route_namea required input onroute-tls/action.ymlwithout a speculative default.route-tls/README.mdusage snippet and documentation to reflect the required input.AGENTS.mdinstructing agents to look up existing route names when migrating..github/workflows/pr-open.ymldry-run steps to passroute_nameexplicitly.