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.

Sign up for GitHub

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

Jump to bottom

📖 e2e tests documentation #142

Merged
merged 4 commits into from
Mar 15, 2022
Merged

📖 e2e tests documentation #142

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
99ac79a
:book: e2e tests documentation
naveensrinivasan Mar 14, 2022
35d5226
Update README.md
naveensrinivasan Mar 15, 2022
47d4c66
Merge branch 'main' into naveen/feat/e2e-tests
naveensrinivasan Mar 15, 2022
78d9705
Update README.md
naveensrinivasan Mar 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions e2e/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# e2e tests

The `e2e` tests for the action is run by running the action every day on a cron for different use cases. The action that run points to `@main` which helps in catching issues sooner.

If these actions fails to run these actions would create an issue in the repository using https://github.com/naveensrinivasan/Create-GitHub-Issue
naveensrinivasan marked this conversation as resolved.
Show resolved Hide resolved

The actions primarily run out of https://github.com/ossf-tests organization.

## Status

| Testcase | Repository | Status. |
| -------- | -------- | -------- |
| Fork | https://github.com/ossf-tests/scorecard-action | [![Fork](https://github.com/ossf-tests/scorecard-action/actions/workflows/scorecards.yml/badge.svg)](https://github.com/ossf-tests/scorecard-action/actions/workflows/scorecards.yml) |
| Non-main-branch | https://github.com/ossf-tests/scorecard-action-non-main-branch | [![non-main-branch](https://github.com/ossf-tests/scorecard-action-non-main-branch/actions/workflows/scorecard-analysis.yml/badge.svg?branch=other)](https://github.com/ossf-tests/scorecard-action-non-main-branch/actions/workflows/scorecard-analysis.yml) |
|Private repository|https://github.com/test-organization-ls/scorecard-action-private-repo-tests| [![Scorecards supply-chain security](https://github.com/test-organization-ls/scorecard-action-private-repo-tests/actions/workflows/scorecard.yml/badge.svg)](https://github.com/test-organization-ls/scorecard-action-private-repo-tests/actions/workflows/scorecard.yml) |


## Steps to add a new test case

1. Create a new repository in the `ossf-tests` organization
2. Clone this workflow https://github.com/ossf-tests/scorecard-action-non-main-branch/blob/other/.github/workflows/scorecard-analysis.yml which has the steps to create an issue if the action fails to run.
3. Update the Title on the issue creation commandline https://github.com/ossf-tests/scorecard-action-non-main-branch/blob/457e0b56ed2b2764fbfa60ce68fdbce315ae3732/.github/workflows/scorecard-analysis.yml#L67. In this example replace `Failed to run automated scorecard-action@main ossf-tests/scorecard-action-non-main-branch` with `Failed to run automated scorecard-action@main with the new org/reponame`
naveensrinivasan marked this conversation as resolved.
Show resolved Hide resolved