Skip to content

Opt-in request: read-only Docs Impact Gate audit pilot #188

Description

@FastPhive

Hello OpenRemote documentation maintainers,

I’m developing Docs Impact Gate, a small open-source GitHub Action that checks whether pull requests changing relevant files also include an explicit documentation, changelog, and version decision.

Your repository looks like a good fit for a voluntary, non-blocking pilot because it:

  • builds documentation for pull requests with GitHub Actions,
  • has explicit documentation versioning rules,
  • distinguishes Next documentation from released versions,
  • already documents when major changes require local build verification.

Would you be interested in trying the Action in audit mode for a short pilot?

The proposed setup would:

  • use enforcement: audit, so it would not block or change merges;

  • read only pull-request metadata and changed filenames;

  • request only contents: read and pull-requests: read;

  • use this immutable release pin:

    FastPhive/docs-impact-gate@6683d10b1aa4768e433bc5ba2498f1f0b9477c70

  • collect only aggregate feedback about false positives, missing rules, and useful reports;

  • require no secrets, source-code upload, private contact details, or payment information.

The pilot can be removed at any time. We would be grateful for even a small number of real pull-request runs, but there is no obligation to reach a specific number.

If you are interested, I can provide the exact workflow snippet and help interpret the first audit results. If not, no action is needed.

Thank you!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions