-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into feature_2206_fair_crps_to_ecnt
- Loading branch information
Showing
18 changed files
with
146 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
**************** | ||
Coding Standards | ||
**************** | ||
|
||
Coming Soon! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
********************** | ||
Continuous Integration | ||
********************** | ||
|
||
Coming Soon! | ||
|
||
Overview | ||
======== | ||
|
||
|
||
Keywords | ||
======== | ||
|
||
|
||
Upstream Testing | ||
================ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
*********************** | ||
Development Environment | ||
*********************** | ||
|
||
Coming Soon! | ||
|
||
Setting Up the Environment | ||
========================== | ||
|
||
|
||
|
||
Autoconf Version | ||
================ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
********* | ||
DockerHub | ||
********* | ||
|
||
Coming Soon! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
************* | ||
Documentation | ||
************* | ||
|
||
Coming Soon! | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
*************** | ||
GitHub Workflow | ||
*************** | ||
|
||
Coming Soon! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
********* | ||
Templates | ||
********* | ||
|
||
Coming Soon! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
******* | ||
Testing | ||
******* | ||
|
||
Coming Soon! | ||
|
||
make test | ||
========= | ||
|
||
|
||
Unit Tests | ||
========== | ||
|
||
Regression Tests | ||
================ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
************ | ||
User Support | ||
************ | ||
|
||
Coming Soon! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,76 @@ | ||
# How to Use Dockerfiles | ||
How to Use Dockerfiles | ||
====================== | ||
|
||
Run all of the Docker commands from the top-level directory of the MET repository | ||
GitHub actions are triggered for Pull Requests to the "develop" and "main_v*" | ||
branches and for pushes to the branches "feature_*", "bugfix_*", "develop", | ||
"develop-ref", and "main_v*" created in this repository to automatically build | ||
images from these Dockerfiles and push them to DockerHub repositories. The | ||
MET Docker image is used in Dockerfiles in the METplus wrappers component | ||
repository for testing. | ||
|
||
## Build MET from clone | ||
Descriptions of the Dockerfiles in this directory are provided below. Sample | ||
commands for building these Docker images locally are also provided. Please | ||
note that these commands should be run from the top-level directory of | ||
the MET repository. | ||
|
||
1. The first example below shows how to manually build a MET Docker image | ||
using code that is cloned from the | ||
[MET GitHub repository](https://github.com/dtcenter/MET/) and using a Docker | ||
image for the base compilation environment for MET from the | ||
[dtcenter/met-base](https://hub.docker.com/repository/docker/dtcenter/met-base) | ||
DockerHub repository. It uses `Dockerfile`, which checks out MET from GitHub, | ||
compiles the specified branch or tag from source, sets a working directory, | ||
downloads and installs GhostScript fonts, and deletes the MET source code for | ||
tagged releases matching "v"*. Tagged versions of the MET Docker image are | ||
available in the | ||
[dtcenter/met](https://hub.docker.com/repository/docker/dtcenter/met-base) | ||
DockerHub repository. | ||
``` | ||
docker build -t dtcenter/met:${TAG_NAME} --build-arg SOURCE_BRANCH=${BRANCH_NAME} internal/scripts/docker | ||
docker push dtcenter/met:${TAG_NAME} | ||
``` | ||
|
||
where: | ||
* TAG_NAME is the name of the DockerHub tag to create | ||
* BRANCH_NAME is the MET branch to checkout | ||
|
||
## Build MET from local source code with minimum requirements | ||
* `${TAG_NAME}` is the name of the DockerHub tag to create | ||
* `${BRANCH_NAME}` is the MET branch to checkout | ||
|
||
2. The second example below shows how to manually build a MET Docker image | ||
using a specified branch or tag from local source code and using a local | ||
Docker image for the base compilation environment for MET from the | ||
[METbaseimage](https://github.com/dtcenter/METbaseimage/) | ||
GitHub repository. (See the | ||
[METbaseimage README.md](https://github.com/dtcenter/METbaseimage/blob/main/README.md) | ||
file for more information on manually creating the Docker image for the base | ||
compilation environment.) This example uses `Dockerfile.copy`, which compiles | ||
MET using the specified branch or tag from local source code, sets a working | ||
directory, downloads and installs GhostScript fonts, and deletes the MET | ||
source code for tagged releases matching "v"*. | ||
``` | ||
docker build -t dtcenter/met:${TAG_NAME} --build-arg SOURCE_BRANCH=${BRANCH_NAME} -f internal/scripts/docker/Dockerfile.copy . | ||
docker push dtcenter/met:${TAG_NAME} | ||
``` | ||
|
||
where: | ||
* TAG_NAME is the name of the DockerHub tag to create | ||
* BRANCH_NAME is the identifier to use for $MET_GIT_NAME inside image | ||
|
||
## Build MET from local source code with unit test requirements | ||
* `${TAG_NAME}` is the name of the DockerHub tag to create | ||
* `${BRANCH_NAME}` is the identifier to use for $MET_GIT_NAME inside image | ||
|
||
3. The third example below shows how to manually build a MET Docker image | ||
using a specified branch or tag from local source code and using a local | ||
Docker image for the base compilation environment along with the additional | ||
packages required for running the MET unit tests from the | ||
[METbaseimage](https://github.com/dtcenter/METbaseimage/) | ||
GitHub repository. (See the | ||
[METbaseimage README.md](https://github.com/dtcenter/METbaseimage/blob/main/README.md) | ||
file for more information on manually creating the Docker image with the base | ||
compilation environment and with the additional packages required for running | ||
the MET unit tests.) This example also uses `Dockerfile.copy`, which is | ||
described above. | ||
``` | ||
docker build -t dtcenter/met:${TAG_NAME} --build-arg SOURCE_BRANCH=${BRANCH_NAME} --build-arg MET_BASE_IMAGE=unit_test_${MET_BASE_IMAGE_VERSION} -f internal/scripts/docker/Dockerfile.copy . | ||
docker build -t dtcenter/met:${TAG_NAME} --build-arg SOURCE_BRANCH=${BRANCH_NAME} --build-arg MET_BASE_TAG=${MET_BASE_TAG} -f internal/scripts/docker/Dockerfile.copy . | ||
docker push dtcenter/met:${TAG_NAME} | ||
``` | ||
|
||
where: | ||
* TAG_NAME is the name of the DockerHub tag to create | ||
* BRANCH_NAME is the identifier to use for $MET_GIT_NAME inside image | ||
* MET_BASE_IMAGE_VERSION is the METbaseimage tag version number | ||
* `${TAG_NAME}` is the name of the DockerHub tag to create | ||
* `${BRANCH_NAME}` is the identifier to use for $MET_GIT_NAME inside image | ||
* `${MET_BASE_TAG}` is the version of [dtcenter/met-base-unit-test](https://hub.docker.com/repository/docker/dtcenter/met-base-unit-test) to be used |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters