Skip to content

Status badges for repositories to use to show their audit status #39

@QuintinWillison

Description

@QuintinWillison

I've been happily musing away on this in another issue (here and then here, in response to @paddybyers's comment here).

I'm now creating this issue to represent this feature.

My current thinking is that a badge for our ably-js repository, indicating status for all checks run across that repository, would live at:

https://sdk.ably.com/builds/ably/repository-audit/main/badges/ably-js.svg

Deep-linking into the downstream repository report output:

https://github.com/ably/repository-audit-report/blob/main/ably.md#ably-js

Therefore the following being added to the top of the README.md document in ably-js:

[![Audit Status](https://sdk.ably.com/builds/ably/repository-audit/main/badges/ably-js.svg)](https://github.com/ably/repository-audit-report/blob/main/ably.md#ably-js)

An implication for this is that the report document would always need to have a deep-linkable heading for every repository it's audited (in this case #ably-js), even if everything was a PASS.

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