SF017 Source links in manifest

input tooling

The user shall be able to declare a source_links section in the project manifest to enable clickable links from code references to the corresponding lines in the hosted repository (GitHub, GitLab, Codeberg, or any compatible platform).

The source_links section shall accept:

• url: the base URL of the repository (e.g. https://github.com/owner/repo). The special value auto instructs Speky to detect it by running git remote get-url origin and normalizing the result to an HTTPS URL.

• branch: the branch or ref used to build links (e.g. main). The special value auto instructs Speky to detect the current branch by running git rev-parse --abbrev-ref HEAD. Defaults to auto when omitted.

Generated links shall have the form: {url}/blob/{branch}/{path_from_git_root}#L{line}

Example:

source_links:
  url: https://github.com/owner/repo
  branch: main

With auto-detection:

source_links:
  url: auto

References

Relates to:

• SF015 Code sources in manifest

• SF016 Scan code for requirement references

Source

Source file: specs/functional.yaml

Loaded from: speky

Implemented in: SourceLinkConfig