Skip to content

For github: URLs any *.yaml file can be a redirect or symlink #4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2025
Merged

For github: URLs any *.yaml file can be a redirect or symlink #4287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions hack/bats/tests/url-github.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ load "../helpers/load"
# │ └── .lima.yaml -> github:jandubois//loop/
# ├── docs
# │ └── .lima.yaml -> ../templates/demo.yaml
# ├── example.yaml -> templates/demo.yaml
# ├── invalid
# │ ├── org
# │ │ └── .lima.yaml -> github:lima-vm
Expand All @@ -35,9 +36,12 @@ load "../helpers/load"
# └── .lima.yaml "{}"
#
# Both the `main` branch and the `v0.0.0` tag have this layout.

#
# All these URLs should redirect to the same template URL (either on "main" or at "v0.0.0"):
# "https://raw.githubusercontent.com/jandubois/jandubois/${tag}/templates/demo.yaml"
#
# Additional tests rely on jandubois/lima existing and containing the v1.2.1 tag.

URLS=(
github:jandubois/jandubois/templates/demo.yaml@main
github:jandubois/jandubois/templates/demo.yaml
Expand All @@ -54,6 +58,10 @@ URLS=(
github:jandubois/
github:jandubois@v0.0.0
github:jandubois
github:jandubois/jandubois/example.yaml
github:jandubois/jandubois/example@main
github:jandubois//example.yaml@v0.0.0
github:jandubois//example
github:jandubois/jandubois/docs/.lima.yaml@main
github:jandubois/jandubois/docs/.lima.yaml
github:jandubois/jandubois/docs/.lima
Expand Down Expand Up @@ -96,11 +104,12 @@ done
}

@test 'hidden files without an extension get a .yaml extension' {
url -0 'github:jandubois//test/.hidden'
assert_output 'https://raw.githubusercontent.com/jandubois/jandubois/main/test/.hidden.yaml'
url -1 'github:jandubois//test/.hidden'
assert_fatal 'file "https://raw.githubusercontent.com/jandubois/jandubois/main/test/.hidden.yaml" not found or inaccessible: status 404'
}

@test 'files that have an extension do not get a .yaml extension' {
# This command doesn't fail because only *.yaml files are checked for redirects/symlinks, and therefore fail right away if they don't exist.
url -0 'github:jandubois//test/.script.sh'
assert_output 'https://raw.githubusercontent.com/jandubois/jandubois/main/test/.script.sh'
}
Expand Down
5 changes: 3 additions & 2 deletions pkg/limatmpl/github.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,9 @@ func transformGitHubURL(ctx context.Context, input string) (string, error) {
}
}

// If filename is .lima.yaml, check if it's a symlink/redirect to another file
if path.Base(filePath) == defaultFilename {
// If filename has a .yaml/.yml extension, check if it's a symlink/redirect to another file
ext := strings.ToLower(path.Ext(filePath))
if ext == ".yaml" || ext == ".yml" {
return resolveGitHubSymlink(ctx, org, repo, branch, filePath, origBranch)
}
return githubUserContentURL(org, repo, branch, filePath), nil
Expand Down
Loading