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

Create Github Container Action #23

Open
abhisek opened this issue Feb 19, 2023 · 2 comments
Open

Create Github Container Action #23

abhisek opened this issue Feb 19, 2023 · 2 comments
Labels
good first issue Good for newcomers

Comments

@abhisek
Copy link
Member

abhisek commented Feb 19, 2023

Requirements

Create Github container action for using vet as a Github action.

Guiding Principal

  • Use good defaults
  • Allow overriding parameters
  • Allow supplying custom filters & filter suites
  • Provide workflow experience instead of tool experience

Workflow over Tool

This is a tool experience

./vet scan ...

This is a workflow experience

steps:
  - name: OSS Vet
    uses: safedep/vet
    with:
      fail_on_match: true  # This is default
      suite: default             # or .vet/suites/custom.yml
      exceptions: .vet/exceptions.yml
@abhisek abhisek added the good first issue Good for newcomers label Feb 19, 2023
@abhisek
Copy link
Member Author

abhisek commented Mar 1, 2023

To setup a Python lib in CI, we had to do some workarounds since we do not support resolving dependencies from setup.py.

python setup.py install
pip freeze > tmp_requirements.txt

Subsequently we run vet to scan the generated requirements

vet scan -D tmp_requirements.txt --lockfile-as requirements.txt ...

@jchauhan Feel free to add your thoughts here.

@abhisek
Copy link
Member Author

abhisek commented Apr 7, 2023

There are just too many command line options. Also new options will be added. The DevEx will be very bad if we build an Action on top of command line arguments.

We should define a config file specification that can be used to configure vet runs in CI using Github action. That will offload all configuration to a file and it can simply be invoked using Github action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant