Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature - adds dockerfile, helper script, build action #669

Merged
merged 2 commits into from
Nov 14, 2023
Merged

feature - adds dockerfile, helper script, build action #669

merged 2 commits into from
Nov 14, 2023

Conversation

JoshCu
Copy link
Contributor

@JoshCu JoshCu commented Oct 28, 2023

Adds a dockerimage to build t-route, a helper script to execute it, and a github action to build and test it.

breakout from #660

Dependencies

#668
#667

Additions

Dockerfile.troute

  • uses rockylinux 9.2
  • installs latest depenencies from epel-release
  • clones latest version of t-route
  • installs requirements.txt
  • runs ./compile.sh

docker/troute.sh

Helper script that allows you to execute the docker container like
it was a local install of t-route e.g.
~ python -m nwm_routing -V3 -f test/LowerColorado_TX/test_AnA.yaml
Can be executed as
~ docker/troute.sh -V3 -f test/LowerColorado_TX/test_AnA.yaml

docker.yml

  • Github action to auto build the docker image from the master branch on push
  • builds from incoming changes on pull request
  • Uses helper script to run the LowerColorado_TX test using the freshly built docker image

Testing

  1. This pr should trigger it 🤞

Notes

  • The build should be separate from the test jobs (this requires an image artifact to be saved or an image upload to dockerhub)
  • While versions aren't locked it's possible this will fail for reasons unrelated to incoming pull requests. (may want a schedulled build of this to those issues early)

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

  • Windows
  • Linux
  • Browser

@shorvath-noaa
Copy link
Contributor

@JoshCu Is this PR ready for review/merge?

@JoshCu JoshCu marked this pull request as ready for review November 10, 2023 21:37
@JoshCu
Copy link
Contributor Author

JoshCu commented Nov 10, 2023

@shorvath-noaa shorvath-noaa merged commit e3fc274 into NOAA-OWP:master Nov 14, 2023
@JoshCu JoshCu deleted the github-action_docker branch November 21, 2023 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants