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

GitLab Pipeline Artifacts/Reports #745

Open
wants to merge 15 commits into
base: dev
Choose a base branch
from
Open

Conversation

gal-dahan
Copy link

@gal-dahan gal-dahan commented Sep 2, 2024

  • All tests passed. If this feature is not already covered by the tests, I added new tests.
  • This pull request is on the dev branch.
  • I used gofmt for formatting the code before submitting the pull request.
  • Update documentation about new features / new supported technologies

Summary:

I have addressed issue #723 by implementing a SARIF generation feature and converting the results into GitLab Code Quality and SAST reports using the sarif-converter in CI. This enhancement enables users to view the results of SCA scans directly within the GitLab pipeline execution, either in the pipeline logs or as job artifacts.

Details:

  • Feature Addition: Implemented SARIF generation.
  • Conversion: Converted SARIF results into GitLab Code Quality and SAST reports using sarif-converter.
  • Documentation: Updated the documentation to include information about the new SARIF generation feature and its integration with GitLab pipelines.

Exmple of .gitlab-ci.yml :

frogbot-scan:
   ...
   ...
  variables: 
     ...
     ...
    JF_SARIF_OUTPUT_PATH: "/sarifOutputPath.sarif"

  script:
     ...
     ...
    - wget -O sarif-converter https://gitlab.com/ignis-build/sarif-converter/-/releases/permalink/latest/downloads/bin/sarif-converter-linux
    - chmod +x sarif-converter
    # Convert SARIF to GitLab SAST format
    - echo "Converting SARIF file to GitLab SAST format"
    - ./sarif-converter --type sast ${JF_SARIF_OUTPUT_PATH} gl-sast-report.json 
  
    artifacts:
    reports:
      sast: gl-sast-report.json

Copy link
Contributor

github-actions bot commented Sep 2, 2024

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@gal-dahan
Copy link
Author

I have read the CLA Document and I hereby sign the CLA

@smsnotes
Copy link

smsnotes commented Sep 5, 2024

Thank you for the work you've put into this pull request. Your effort in addressing specific issue is much appreciated.
Could you please promote this PR? It's crucial for my organization , and getting it through to the next stage would be very beneficial.

@gal-dahan
Copy link
Author

Hi, just checking in to see if anyone has had a chance to review this PR. Please let me know if anything is needed from my side. Thanks!

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

Successfully merging this pull request may close these issues.

3 participants