Skip to content

Commit

Permalink
adding periods to most bullet lists #770
Browse files Browse the repository at this point in the history
  • Loading branch information
lisagoodrich committed Apr 25, 2022
1 parent 8ab73cc commit 90282b6
Showing 1 changed file with 32 additions and 32 deletions.
64 changes: 32 additions & 32 deletions docs/Contributors_Guide/continuous_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Continuous Integration
METplus utilizes GitHub Actions to run processes automatically when changes
are pushed to GitHub. These tasks include:

* Building documentation to catch warnings/errors
* Building a Docker image to run tests
* Creating/Updating Docker data volumes with new input data used for tests
* Running unit tests
* Running use cases
* Comparing use case output to truth data
* Creating/Updating Docker data volumes with truth data to use in comparisons
* Building documentation to catch warnings/errors.
* Building a Docker image to run tests.
* Creating/Updating Docker data volumes with new input data used for tests.
* Running unit tests.
* Running use cases.
* Comparing use case output to truth data.
* Creating/Updating Docker data volumes with truth data to use in comparisons.

GitHub Actions Workflows
========================
Expand Down Expand Up @@ -167,8 +167,8 @@ Push
This configuration tells GitHub Actions to trigger the workflow when changes
are pushed to the repository and the following criteria are met:

* The branch is named *develop* or *develop-ref*
* The branch starts with *feature\_, main\_*, or *bugfix\_*
* The branch is named *develop* or *develop-ref*.
* The branch starts with *feature\_, main\_*, or *bugfix\_*.
* Changes were made to at least one file that is not in the *docs* directory.

Pull Request
Expand Down Expand Up @@ -224,12 +224,12 @@ to trigger this workflow.
It lists the input values that are passed from the external repository.
The inputs include:

* The repository that triggered the workflow, such as *dtcenter/MET*
* The commit hash in the external repository that triggered the event
* The repository that triggered the workflow, such as *dtcenter/MET*.
* The commit hash in the external repository that triggered the event.
* The reference (or branch) that triggered the event, such as
*refs/heads/develop*
*refs/heads/develop*.
* The GitHub username that triggered the event in the external repository
(optional)
(optional).

The MET, METcalcpy, and METplotpy repositories are configured to
trigger this workflow since they are used in 1 or more METplus use cases.
Expand All @@ -249,12 +249,12 @@ Each item under **jobs** is a string that defines the ID of the job.
This value can be referenced within the workflow as needed.
Each job in the testing workflow is described in its own section.

* :ref:`cg-ci-event-info`
* :ref:`cg-ci-job-control`
* :ref:`cg-ci-get-image`
* :ref:`cg-ci-update-data-volumes`
* :ref:`cg-ci-use-case-tests`
* :ref:`cg-ci-create-output-data-volumes`
* :ref:`cg-ci-event-info`.
* :ref:`cg-ci-job-control`.
* :ref:`cg-ci-get-image`.
* :ref:`cg-ci-update-data-volumes`.
* :ref:`cg-ci-use-case-tests`.
* :ref:`cg-ci-create-output-data-volumes`.

.. _cg-ci-event-info:

Expand Down Expand Up @@ -393,10 +393,10 @@ On Push

When a push event occurs the default behavior is to run the following:

* Create/Update the METplus Docker image
* Look for new input data
* Run unit tests
* Run any use cases marked to run (see :ref:`cg-ci-use-case-tests`)
* Create/Update the METplus Docker image.
* Look for new input data.
* Run unit tests.
* Run any use cases marked to run (see :ref:`cg-ci-use-case-tests`).

If the push is on the *develop* or a *main_vX.Y* branch, then all
of the use cases are run.
Expand All @@ -423,9 +423,9 @@ Branches with a name that ends with *-ref* contain the state of the
repository that will generate output that is considered "truth" data.
In addition to the jobs run for a push, the scripts will:

* Run all use cases
* Run all use cases.
* Create/Update Docker data volumes that store truth data with the use case
output
output.

See :ref:`cg-ci-create-output-data-volumes` for more information.

Expand All @@ -438,14 +438,14 @@ The automation logic reads the commit message for the last commit before a
push. Keywords in the commit message can override the default behavior.
Here is a list of the currently supported keywords and what they control:

* **ci-skip-all**: Don't run anything - skip all automation jobs
* **ci-skip-use-cases**: Don't run any use cases
* **ci-skip-unit-tests**: Don't run the Pytest unit tests
* **ci-run-all-cases**: Run all use cases
* **ci-skip-all**: Don't run anything - skip all automation jobs.
* **ci-skip-use-cases**: Don't run any use cases.
* **ci-skip-unit-tests**: Don't run the Pytest unit tests.
* **ci-run-all-cases**: Run all use cases.
* **ci-run-diff**: Obtain truth data and run diffing logic for
use cases that are marked to run
use cases that are marked to run.
* **ci-run-all-diff**: Obtain truth data and run diffing logic for
all use cases
all use cases.

.. _cg-ci-get-image:

Expand Down Expand Up @@ -703,7 +703,7 @@ to run a use case:
* **py_embed** - Used if a different Python environment is required to
run a Python Embedding script. If this keyword is included with a Python
environment, then the MET_PYTHON_EXE environment variable will be set to
specify the version of Python3 that is included in that environment
specify the version of Python3 that is included in that environment.

Example::

Expand Down

0 comments on commit 90282b6

Please sign in to comment.