Skip to content

Bug: The sync mechanism must ensure that a header comment is present on all sync'd material indicating the source and that it is not to be edited locally #415

Description

@trevor-vaughan

Prerequisites

  • I have searched for existing issues
  • This is not a security vulnerability (report via the repository's SECURITY.md)

Describe the bug

When scanners, such as zizmor and actionlint, scan for issues in a repository, it must be obvious as to whether or not a file is injected by org-infra.

Without this, updates will be made that require undocumented understanding of the structure of the system and make it difficult for agentic updates to succeed correctly.

Example: complytime/complyctl#710 (review)

To Reproduce

  1. Have lint errors
  2. Fix lint errors
  3. Watch your fixes be overwritten at the next sync

Expected behavior

Both humans and LLMs understand where issues should be resolved at all times without needing to understand any non-obvious context.

Screenshots

Related: #256

Environment

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Fields

    Priority

    None yet

    Effort

    None yet

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions