Decouple repository root resolver from internal logic

[teresaromero]

Resolves #2797

This pull request refactors how repository root and links definitions files are discovered and used throughout the codebase, improving consistency, error handling, and test coverage. The main changes include passing the repository root explicitly to functions that need it, updating the logic for finding and reading the links definitions file, and enhancing license file handling during package builds. Comprehensive unit tests have been added for these new behaviors.

Repository root and links file handling:

• All commands (build, lint, and links-related commands in cmd/build.go, cmd/lint.go, cmd/links.go) now explicitly locate and pass the repository root using files.FindRepositoryRoot(), and use this to find the links definitions file via docs.LinksDefinitionsFilePath(repoRoot). This improves reliability and consistency in locating project resources. [1] [2] [3] [4] [5] [6]

License file handling during build:

• The build logic in internal/builder/packages.go now takes the repository root as a parameter and uses it to locate and copy the license file into the package, supporting overrides via environment variable and handling missing files gracefully. The helper functions have been refactored for clarity and improved error handling. [1] [2] [3] [4] [5]

Links map logic and API changes:

• The links map implementation in internal/docs/links_map.go has been refactored to use pointer receivers, provide clearer error handling, and accept the links file path explicitly. The logic for finding the links definitions file now checks environment variables first and falls back to the default file in the repository root, returning an empty string if not found. [1] [2] [3]

Unit tests for new behaviors:

• New and updated tests in internal/builder/packages_test.go and internal/docs/links_map_test.go cover repository license file discovery, license copying logic, and links file resolution under various scenarios (env var, missing file, default file, YAML parsing). [1] [2]

Imports and cleanup:

• Imports have been updated to support the new logic, and unused imports have been removed for clarity. [1] [2]

[mrodm]

Variable includedFilePathRelFromRoot could be also a relative path outside repoRoot (something like ../path).

Would that fail repoRoot.Stat() in that case?

[teresaromero]

the included file can be outside the repo root? i thought all files should be within the repo..

includedFilePath is the absolute path for the included file, taking into account the join of the relative path described inside the link file and the workdir.

includedFilePathRelFromRoot is then the relative from root, if this is outside root, repoRoot.Stat will fail, as it wont be valid? i would need confirmation of this. Right now is restricted to root

[teresaromero]

@mrodm i've updated the code with your feedback. i usually mark resolved the comments that have been addressed, please re-open if you find anything pending.

thanks

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: 9b7a721

History

• 💔 Build #6314 failed 4412b0b
• 💔 Build #6313 failed ecfeb9b
• 💚 Build #6264 succeeded c60b836
• 💔 Build #6263 failed 9edca9b
• 💔 Build #6252 failed 385fc89