diff --git a/.github/actions/check-controller-build/action.yml b/.github/actions/check-controller-build/action.yml index e75e60ad..4f4129e9 100644 --- a/.github/actions/check-controller-build/action.yml +++ b/.github/actions/check-controller-build/action.yml @@ -14,7 +14,7 @@ inputs: description: "Where is the workshop repository to check for workshop updates" required: true ci-target-directory: - descriptiopn: "Where is the current CI target repository to check for controller image related changes" + description: "Where is the current CI target repository to check for controller image related changes" required: true outputs: build-controller: diff --git a/.github/actions/check-controller-build/check-controller-build.sh b/.github/actions/check-controller-build/check-controller-build.sh index 0f09256b..b63d71e1 100755 --- a/.github/actions/check-controller-build/check-controller-build.sh +++ b/.github/actions/check-controller-build/check-controller-build.sh @@ -75,7 +75,7 @@ else echo "Files changed:" ${diff_cmd} if [ $? != 0 ]; then - error "could not obtian git-diff output" + error "could not obtain git-diff output" fi echo @@ -123,8 +123,9 @@ else else error "Required history not available for CI target directory '${ci_target_directory}'" fi + popd else - error "Failed to pushd to CI target directory '${ci_target_directory}" + error "Failed to pushd to CI target directory '${ci_target_directory}'" fi fi fi diff --git a/.github/actions/check-controller-build/validate-inputs.sh b/.github/actions/check-controller-build/validate-inputs.sh index ec2fc467..912902bd 100755 --- a/.github/actions/check-controller-build/validate-inputs.sh +++ b/.github/actions/check-controller-build/validate-inputs.sh @@ -19,7 +19,7 @@ function usage() { echo " is a yes|no value" echo " is a yes|no value" echo " is a directory where the crucible repository exists." - echo " is a directory where the workshop repoistory exists." + echo " is a directory where the workshop repository exists." echo " is a directory where the current CI target repository exists." echo echo "If is 'yes' then the action short circuits and returns 'no'" diff --git a/.github/actions/common-code/common-code.sh b/.github/actions/common-code/common-code.sh index 569866cf..979697ea 100644 --- a/.github/actions/common-code/common-code.sh +++ b/.github/actions/common-code/common-code.sh @@ -71,7 +71,7 @@ function validate_ci_endpoint { } function do_ssh { - ssh -o PasswordAuthentication=no $@ + ssh -o PasswordAuthentication=no "$@" } # Run command on endpoint - use direct execution for localhost, SSH otherwise diff --git a/.github/actions/get-releases/generate-release-list.sh b/.github/actions/get-releases/generate-release-list.sh index fc389955..6e7de016 100755 --- a/.github/actions/get-releases/generate-release-list.sh +++ b/.github/actions/get-releases/generate-release-list.sh @@ -47,7 +47,7 @@ if pushd ${crucible_directory}; then else # history is not available - echo "INFO: Required history not availble, assuming no changes to installer script" + echo "INFO: Required history not available, assuming no changes to installer script" fi popd diff --git a/.github/actions/install-crucible/install-crucible.sh b/.github/actions/install-crucible/install-crucible.sh index a697d689..1ade95a3 100755 --- a/.github/actions/install-crucible/install-crucible.sh +++ b/.github/actions/install-crucible/install-crucible.sh @@ -320,7 +320,7 @@ if [ "${CI_CONTROLLER}" == "yes" -a "${DISABLE_FORCE_BUILDS}" == "no" ]; then FORCE_BUILDS="true" echo "Updating rickshaw-settings value workshop.force-builds to '${FORCE_BUILDS}' in ${RICKSHAW_SETTINGS_FILE}" - # handle backwards copmatibility to when force_builds was a string + # handle backwards compatibility to when force_builds was a string # instead of a boolean jq_argument_type=argjson case "${RELEASE_TAG}" in diff --git a/.github/actions/integration-tests/run-ci-stage1 b/.github/actions/integration-tests/run-ci-stage1 index 2d4a19ef..1a4d01b2 100755 --- a/.github/actions/integration-tests/run-ci-stage1 +++ b/.github/actions/integration-tests/run-ci-stage1 @@ -376,7 +376,7 @@ function post_run_cmd { FORCE_BUILDS="false" echo "Updating rickshaw-settings value workshop.force-builds to '${FORCE_BUILDS}' in ${RICKSHAW_SETTINGS_FILE}" - # handle backwards copmatibility to when force_builds was a + # handle backwards compatibility to when force_builds was a # string instead of a boolean jq_argument_type=argjson case "${CI_RELEASE}" in diff --git a/.github/rulesets/README.md b/.github/rulesets/README.md index 49036d3f..2f680835 100644 --- a/.github/rulesets/README.md +++ b/.github/rulesets/README.md @@ -1 +1 @@ -The files stored here are for documentation / tracking purposes only. They must be loaded into the GitHub web GUI to be "active" -- there presence here does not result in any behavioral changes by GitHub. +The files stored here are for documentation / tracking purposes only. They must be loaded into the GitHub web GUI to be "active" -- their presence here does not result in any behavioral changes by GitHub. diff --git a/.github/workflows/core-endpoint-crucible-ci.yaml b/.github/workflows/core-endpoint-crucible-ci.yaml index 9c7a57ce..b99bdf1c 100644 --- a/.github/workflows/core-endpoint-crucible-ci.yaml +++ b/.github/workflows/core-endpoint-crucible-ci.yaml @@ -220,7 +220,7 @@ jobs: ENGINE_REGISTRY_AUTH_SECRET: ${{ secrets.production_registry_auth }} if: ${{ env.ENGINE_REGISTRY_AUTH_SECRET != '' }} run: sudo bash -c "echo \"$ENGINE_REGISTRY_AUTH_SECRET\" > /root/crucible-production-engines-token.json" - - name: import quay oath token + - name: import quay oauth token env: QUAY_OAUTH_TOKEN: ${{ secrets.quay_oauth_token }} if: ${{ env.QUAY_OAUTH_TOKEN != '' }} diff --git a/.github/workflows/core-release-crucible-ci.yaml b/.github/workflows/core-release-crucible-ci.yaml index 39008ff1..8870b1fc 100644 --- a/.github/workflows/core-release-crucible-ci.yaml +++ b/.github/workflows/core-release-crucible-ci.yaml @@ -220,7 +220,7 @@ jobs: if: ${{ needs.gen-params.outputs.build_controller == 'yes' && env.ENGINE_REGISTRY_AUTH_SECRET != '' }} run: sudo bash -c "echo \"$ENGINE_REGISTRY_AUTH_SECRET\" > /root/crucible-production-engines-token.json" - - name: import quay oath token + - name: import quay oauth token env: QUAY_OAUTH_TOKEN: ${{ secrets.quay_oauth_token }} if: ${{ needs.gen-params.outputs.build_controller == 'yes' && env.QUAY_OAUTH_TOKEN != '' }} diff --git a/.github/workflows/endpoint-crucible-ci.yaml b/.github/workflows/endpoint-crucible-ci.yaml index 85bc2982..609fd39c 100644 --- a/.github/workflows/endpoint-crucible-ci.yaml +++ b/.github/workflows/endpoint-crucible-ci.yaml @@ -158,7 +158,7 @@ jobs: ENGINE_REGISTRY_AUTH_SECRET: ${{ secrets.production_registry_auth }} if: ${{ env.ENGINE_REGISTRY_AUTH_SECRET != '' }} run: sudo bash -c "echo \"$ENGINE_REGISTRY_AUTH_SECRET\" > /root/crucible-production-engines-token.json" - - name: import quay oath token + - name: import quay oauth token env: QUAY_OAUTH_TOKEN: ${{ secrets.quay_oauth_token }} if: ${{ env.QUAY_OAUTH_TOKEN != '' }} diff --git a/.github/workflows/test-benchmark-crucible-ci.yaml b/.github/workflows/test-benchmark-crucible-ci.yaml index 9530ec4f..665f2689 100644 --- a/.github/workflows/test-benchmark-crucible-ci.yaml +++ b/.github/workflows/test-benchmark-crucible-ci.yaml @@ -21,6 +21,7 @@ jobs: with: files: | LICENSE + .gitignore *.md **/*.md .github/rulesets/** diff --git a/.github/workflows/test-core-crucible-ci.yaml b/.github/workflows/test-core-crucible-ci.yaml index b609ac71..73198578 100644 --- a/.github/workflows/test-core-crucible-ci.yaml +++ b/.github/workflows/test-core-crucible-ci.yaml @@ -21,6 +21,7 @@ jobs: with: files: | LICENSE + .gitignore *.md **/*.md .github/rulesets/** diff --git a/.github/workflows/test-tool-crucible-ci.yaml b/.github/workflows/test-tool-crucible-ci.yaml index 798de521..b5f0dcc8 100644 --- a/.github/workflows/test-tool-crucible-ci.yaml +++ b/.github/workflows/test-tool-crucible-ci.yaml @@ -21,6 +21,7 @@ jobs: with: files: | LICENSE + .gitignore *.md **/*.md .github/rulesets/** diff --git a/README.md b/README.md index 7aa54404..d00e02a0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## Introduction -Crucible-CI is a Continuous Integration (CI) testing harness targeted at the [Crucible](https://github.com/perftool-incubator/crucible) performance automation and analysis framework. Crucible is comprised of [many subprojects](https://github.com/perftool-incubator/crucible#subprojects) with each subproject having it's own repository. As such, the primary goal of Crucible-CI is to be able to perform integration testing of a given subproject when changes to it are proposed via a pull request. +Crucible-CI is a Continuous Integration (CI) testing harness targeted at the [Crucible](https://github.com/perftool-incubator/crucible) performance automation and analysis framework. Crucible is comprised of [many subprojects](https://github.com/perftool-incubator/crucible#subprojects) with each subproject having its own repository. As such, the primary goal of Crucible-CI is to be able to perform integration testing of a given subproject when changes to it are proposed via a pull request. What this means is that when a pull request is submitted for a project that is a member of the Crucible family a working Crucible installation is created using the primary branch of all the other repositories and the proposed code for the specific repository that the pull request is for. This installation is then used to perform integration testing of the pull request's changes combined with all of the other project's current upstream code. @@ -80,7 +80,7 @@ These actions are where actual Crucible testing is performed. The [integration-tests](.github/actions/integration-tests) action is where, as the name implies, the integration testing is performed. This action has several different possible inputs, but all of them are optional. By default it will run a very simple integration test based on the default values. By specifying one or more of the available inputs the action can be "tuned" for the type of testing that is desired in the calling workflow. -The integration test is comprised of multiple shell scripts that perform different actions. Some of these scripts are usually specific to the GitHub runner environment, such as [setup-ci-environment](.github/actions/integration-tests/setup-ci-environment) (since it performs a custon install of Crucible), while others can be used outside of the Github runner environment to perform testing in a development environment with an existing running Crucible installation. An example of this is the use of [run-ci-stage1](.github/actions/integration-tests/run-ci-stage1) (which is the actual "test" in this action, the other scripts are primarily for setup and reporting) by the Crucible [`run-ci`](https://github.com/perftool-incubator/crucible/blob/bcdde354c751baff60f8cb9d68203113ec4c3439/bin/_help#L48) command. +The integration test is comprised of multiple shell scripts that perform different actions. Some of these scripts are usually specific to the GitHub runner environment, such as [setup-ci-environment](.github/actions/integration-tests/setup-ci-environment) (since it performs a custom install of Crucible), while others can be used outside of the GitHub runner environment to perform testing in a development environment with an existing running Crucible installation. An example of this is the use of [run-ci-stage1](.github/actions/integration-tests/run-ci-stage1) (which is the actual "test" in this action, the other scripts are primarily for setup and reporting) by the Crucible [`run-ci`](https://github.com/perftool-incubator/crucible/blob/bcdde354c751baff60f8cb9d68203113ec4c3439/bin/_help#L48) command. ### Workflows