Skip to content

Restructure the contents of the MET repository so that it matches the existing release tarfiles. #1920

@JohnHalleyGotway

Description

@JohnHalleyGotway

NOTE: This will be a major change to all existing development branches!

Describe the Task

Motivation:

  • Make it easier to compile MET directly from GitHub.
  • Utilizing GitHub's release creation rather than manually building/attaching a custom release tarfile.
  • Supports the METplus use of Manage Externals.

Recommend making the following changes:

  • Store the output of running bootstrap (Makefile.in, configure, etc) directly in the repo.
  • Store the output of running enum_to_string anf ylwrap directly in the repo.
  • Modify enum_to_string logic to NOT include the timestamp of the runtime in its output. Otherwise we'd end up with lots of diffs in the future where the only real diff is that timestamp.
  • Move the contents of the "met" directory up to the top-level of the repo.
  • Create a top-level directory for "internal".
  • Move existing top-level "scripts" and "test" directories into the new "internal" directory. Consider renaming "test" to something else, perhaps "unit_tests"?
  • Prune any existing scripts that are no longer needed after this change.
  • Update and test all existing scripts to make sure they still work.
  • Update the nightly build script in particular.
  • Test the compile_all_MET.sh script and update as needed.
  • Update the DockerHub build rules since the location of the Dockerfile will have changed.
  • Test/fix the RTD automation logic, if needed.
  • Update the logic for $MET_DEVELOPMENT. Commit the files created by it directly to the repository. If that env var is set, recreate them as necessary. If not, use them as is from the repo. Also, only compile ‘internal’ code if set.
  • Update the ‘make dist’ logic. It still is useful to build a tar file in this way. But it will likely need to do fewer things.
  • Update the METplus Release Guide instructions... they should be simpler now.
  • Create a branch and PR in the hpc-stack repo to update the code to install MET (Julie)
  • Communicate with Will Hatheway about the impact on his scripts (Julie)

The main goal is minimizing impacts on existing scripts and installation instructions so that any that worked previously with a released tarfile will continue to work with GitHub's tarfile.

Be sure to go a git move instead of delete/add so that it can keep tracks of these changes.

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

Sub-Issues

Consider breaking the task down into sub-issues.
No sub-issues needed.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Split 2702691, 2792541

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required: @JohnHalleyGotway (and @georgemccabe is willing to help if needed)
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Linked issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.

Metadata

Metadata

Type

No type

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions