Skip to content

Commit

Permalink
Merge pull request #23 from RedHatInsights/readme
Browse files Browse the repository at this point in the history
A little readme fixup
  • Loading branch information
maknop authored Sep 15, 2023
2 parents eaeec85 + 44a5063 commit ac3dfe9
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
Utilities used to run smoke tests in an ephemeral environment within a CI/CD pipeline

## Getting Started
Grab the [Jenkinsfile template](templates/Jenkinsfile) and cater it to your specific needs. This file should reside in your git repositories root directory. That Jenkinsfile will
download the necessary files from this repository. It does not have a unit test file so that will need to be made in your repository. You can find a
unit test template file [here](templates/unit_test_example.sh).
Grab the Jenkinsfile template for your [backend](examples/backend-pipeline-pr-checks/Jenkinsfile) or [frontend](examples/frontends-pipeline-pr-checks/Jenkinsfile) and cater it to your specific needs. This file should reside in your git repositories root directory. That Jenkinsfile will download the necessary files from this repository. It does not have a unit test file so that will need to be made in your repository. You can find a unit test template file [here](examples/unit_test_example.sh).

## Scripts

Expand Down Expand Up @@ -79,10 +77,11 @@ is **set only once the first command using the library helper function `containe
## Template Scripts
| Script | Description |
| ----------------------- | ----------- |
| example/Jenkinsfile | |
| example/pr_check_template.sh | |
| example/unit_test_example.sh | |
| example/unit_test_example_ephemeral_db.sh | |
| examples/backend-pipeline-pr-checks/Jenkinsfile | Templated example of the pr-check pipeline for backend apps |
| examples/frontends-pipeline-pr-checks/Jenkinsfile | Templated example of the pr-check pipeline for frontend apps |
| examples/pr_check_template.sh | |
| examples/unit_test_example.sh | |
| examples/unit_test_example_ephemeral_db.sh | |

## Contributing

Expand Down

0 comments on commit ac3dfe9

Please sign in to comment.