Writing my first contribution to the catalog, I failed to find the
authoring recommendations, resulting in unnecessary Slack noise.
This adds references to parts of the documentation that I did
read in the hope that others will see them in time.
I removed the recommendations list that was inlined in CONTRIBUTING.md
as it is covered by the linked recommendations.md.
We are detecting the task that only has been modified or added with the help of
git diff against the 'main' branch.
If we set and define the variable TEST_RUN_ALL_TESTS it will force running all
the tests and not just the modified ones.
Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Taking the trigger-jenkins-build e2e tests example of spinning a jenkins server
inside the test namespace we document an alternative to the 'reflector' tests
for e2e test.
This is documented as the 'first' one since probably more robust to test that
way than the reflector testing.
Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
We were previously using the outdated git_clone version 0.1 in the
add_git_clone_task function.
So let's introduce a more generic function :
```
add_task ${task} ${version}
```
if version is 'latest' it will always install the latest version of the task.
Change all pre-apply-task-hook to use that function instead.
Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
This script will allow the developer to test a task directly withouth having to
send it to the CI and wait that all tasks runs to test it.
Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Centralize all the the git-clone apply commands we had around the
pre-apply-task-hook to a central common function.
This will make easier to have the same git-clone task version used everywhere.
Add some documentation about the helper functions along the way.
Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
In this repo at the moment the line between the 2 docs is not very clear
since developing pretty much is contributing. The info one needed to
submit to the catalog seemed spread across both so I combined them into
one.
Going forward the development.md is probably a good place to include
info for folks maintaining automation for the catalog.
