Skip to content

feat: remote auditing - #230

Merged
woodruffw merged 13 commits into
mainfrom
ww/fetch-repo
Dec 5, 2024
Merged

feat: remote auditing#230
woodruffw merged 13 commits into
mainfrom
ww/fetch-repo

Conversation

@woodruffw

@woodruffw woodruffw commented Dec 4, 2024

Copy link
Copy Markdown
Member

WIP.

Once finished, this will enable zizmor foo/bar, where foo/bar is a GitHub repo that zizmor will extract workflows to audit from.

(The @-prefix is not a firm design choice -- I might remove that.)

Closes #50

Closes #177

CC @miketheman as an interested party 🙂

@woodruffw woodruffw added enhancement New feature or request cli labels Dec 4, 2024
@woodruffw woodruffw self-assigned this Dec 4, 2024
@miketheman

Copy link
Copy Markdown
Member

Woohoo, thanks for taking this on!

(The @-prefix is not a firm design choice -- I might remove that.)

I agree - especially considering that we cannot predict the future of Naming Things.

In my head, it's absolutely fine and fair to use the entire repo URL as the input - and this don't have to "teach" a new thing.

@miketheman

miketheman commented Dec 4, 2024

Copy link
Copy Markdown
Member

For completeness, an example:

zizmor https://github.com/foo/bar

@woodruffw

woodruffw commented Dec 4, 2024

Copy link
Copy Markdown
Member Author

In my head, it's absolutely fine and fair to use the entire repo URL as the input - and this don't have to "teach" a new thing.

True -- the only reason why I'm shying away from this is because I don't want to have to teach zizmor how to validate URLs, versus being given a slug that it can make correct-by-construction into a GitHub URL.

For example, I don't want to get bug reports for ssh:// URLs, or GHE deployments, or for http://random-filehost.example.com/why-is-there-a-workflow-here.yml 🙂

As a middle ground, I think I'll drop the @ prefix but go with a convention that's already universal on GitHub, namely org/repo(@ref)?. That can be disambiguated easily from a local file by testing for presence, and leaves open changing to a full URL input in the future if/when that becomes pressing. That way no new syntax is invented here, at least.

Signed-off-by: William Woodruff <william@yossarian.net>
Signed-off-by: William Woodruff <william@yossarian.net>
Signed-off-by: William Woodruff <william@yossarian.net>
Signed-off-by: William Woodruff <william@yossarian.net>
Signed-off-by: William Woodruff <william@yossarian.net>
Signed-off-by: William Woodruff <william@yossarian.net>
Signed-off-by: William Woodruff <william@yossarian.net>
Signed-off-by: William Woodruff <william@yossarian.net>
Signed-off-by: William Woodruff <william@yossarian.net>
Signed-off-by: William Woodruff <william@yossarian.net>
@woodruffw woodruffw changed the title feat: fetch workflows from GitHub feat: remote auditing Dec 5, 2024
Signed-off-by: William Woodruff <william@yossarian.net>
@woodruffw
woodruffw merged commit 3a3a5c8 into main Dec 5, 2024
@woodruffw
woodruffw deleted the ww/fetch-repo branch December 5, 2024 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refactor: switch to camino for path handling Support remote auditing?

2 participants