Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: support auditing (composite) actions #173

Closed
2 tasks done
jku opened this issue Nov 18, 2024 · 3 comments · Fixed by #331
Closed
2 tasks done

Feature: support auditing (composite) actions #173

jku opened this issue Nov 18, 2024 · 3 comments · Fixed by #331
Labels
enhancement New feature or request
Milestone

Comments

@jku
Copy link

jku commented Nov 18, 2024

Pre-submission checks

  • I am not reporting a bug (crash, false positive/negative, etc). These must be filed via the bug report template.
  • I have looked through the open issues for a duplicate request.

What's the problem this feature will solve?

Action.yml, especially when the action is a composite action, can have many of the same pitfalls that ẃorkflows do: being able to audit them would be great.

Currently zizmore fails with

failed to register workflow

Caused by:
    0: couldn't load workflow from file
    1: invalid GitHub Actions workflow: "my-action/action.yml"
    2: missing field `on`

Describe the solution you'd like

  • zizmor should ideally work on actions.yml files in general
  • composite actions would benefit the most since they are much like workflows

This should be doable since the composite actions syntax is fairly similar to workflows (but it also might not be trivial since there are so many small differences).

Additional context

No response

@jku jku added the enhancement New feature or request label Nov 18, 2024
@woodruffw
Copy link
Owner

Thanks @jku! This is listed in the roadmap in #1, but it's great to have a separate issue for this as well.

I agree about the value of doing this -- I'll be looking into initial support in the coming weeks. The underlying data models already support action definitions well, it's mostly just a matter of defining an ActionAudit or similar trait.

@woodruffw
Copy link
Owner

#188 gets us a bit closer to composite action auditing by adding the Audit supertrait, which the future ActionAudit can then compose over.

@woodruffw
Copy link
Owner

A basic version of this has landed with #331, with some initial audit support. Implementation for the rest of the audits is tracked in #350!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants