Skip to content

Conversation

@cx-ricardo-jesus
Copy link
Contributor

@cx-ricardo-jesus cx-ricardo-jesus commented Sep 30, 2025

Closes #

Reason for Proposed Changes

  • The goal of this PR is to give the community more clarity and actionable guidance when contributing to this open source repository, ensuring they have the necessary information to handle potential pipeline issues.
  • Currently, specifically on the E2E tests README file, there is some information that needs to be changed or added.

Proposed Changes

  • On the contributions page, in the section Get Started!, added a note, mentioning that if the changes made cause the KICS pipeline to fail, the community can follow the steps outlined in the new Tips section.
  • This new Tips section covers the following cases:
    • Pipeline failing on E2E tests, with a detailed explanation, step by step, explaining how to solve this problem.
    • What to expect when a GitGuard Security Check fail on the pipeline.
    • A subsection describing some detected flaky tests that may occur and what happens in these cases.
    • A subsection describing two possible ways of searching for the root cause of a problem when a pipeline fails due to the unit tests.
    • Another subsection describing the cases when the pipeline fails on Grype or Trivy tests, which could only need to change the version of a library(needs to be confirmed if it is the community that has to change a version of a library on the go.mod file). It is also mentioned that this is not the only case for the failures regarding the Grype or Trivy tests, and a change on the go and git images on the Dockerfile sometimes will be needed(just informing, because it's the teams that are responsible for changing that), or it could be a different case.
  • On the E2E tests README, after running them locally and from Docker, I changed some information about which tests are currently failing, which, from what I tested, are presently not correct.
  • Also added on the E2E README page, a subsection that lists all the technologies that need to be installed to run all the commands mentioned in the entire README.
  • Added one extra information that, in my point of view, is currently missing, that is the option to use a flag -timeout to extend the time that the E2E tests spend running. (e.g., -timeout 60m).

I submit this contribution under the Apache-2.0 license.

@cx-ricardo-jesus cx-ricardo-jesus requested a review from a team as a code owner September 30, 2025 09:57
@cx-ricardo-jesus cx-ricardo-jesus marked this pull request as draft September 30, 2025 09:57
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 30, 2025
@github-actions
Copy link
Contributor

kics-logo

KICS version: v2.1.13

Category Results
CRITICAL CRITICAL 0
HIGH HIGH 0
MEDIUM MEDIUM 0
LOW LOW 0
INFO INFO 0
TRACE TRACE 0
TOTAL TOTAL 0
Metric Values
Files scanned placeholder 1
Files parsed placeholder 1
Files failed to scan placeholder 0
Total executed queries placeholder 47
Queries failed to execute placeholder 0
Execution time placeholder 0

@cx-ricardo-jesus cx-ricardo-jesus changed the title docs(contribution): changed e2e test fixture on purpose docs(contribution): added extra information on the contributing page from the KICS documentation Sep 30, 2025
@github-actions github-actions bot added docker Docker query dockerfile labels Oct 2, 2025
@cx-ricardo-jesus cx-ricardo-jesus self-assigned this Oct 2, 2025
@cx-ricardo-jesus cx-ricardo-jesus marked this pull request as ready for review October 2, 2025 12:58
Copy link
Contributor

@cx-artur-ribeiro cx-artur-ribeiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some comments to improve the text, minimal but quality changes 😃

cx-ricardo-jesus and others added 6 commits October 3, 2025 14:47
Co-authored-by: Artur Ribeiro <[email protected]>
Co-authored-by: Artur Ribeiro <[email protected]>
Co-authored-by: Artur Ribeiro <[email protected]>
Co-authored-by: Artur Ribeiro <[email protected]>
Co-authored-by: Artur Ribeiro <[email protected]>
Co-authored-by: Artur Ribeiro <[email protected]>
Copy link
Contributor

@cx-artur-ribeiro cx-artur-ribeiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just 2 typo fixes 😅
All good to me after that.

Co-authored-by: Artur Ribeiro <[email protected]>
Copy link
Contributor

@cx-artur-ribeiro cx-artur-ribeiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docker Docker query dockerfile documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants