Consider using only .yml or only .yaml extensions

jprestop commented 7 months ago

Describe the Task

When working on #264 it was noted that there are both .yml files and .yaml files, in the repository, which was a source of some confusion. Considering renaming files (and changing any references to those files) for consistency.

jpresto$ find . -name "*yml"
./.github/workflows/release-checksum.yml
./.github/workflows/unit_tests.yml
./.github/workflows/trigger_metplus.yml
./.github/workflows/compare_db.yml
./.github/workflows/main.yml
./.github/workflows/documentation.yml

jpresto$ find . -name "*yaml"
./METdbLoad/sql/scripts/data_loading_config.yaml
./METreadnc/test/test_readnc_env.yaml
./METreadnc/test/test_readnc.yaml
./METreadnc/util/read_netcdf.yaml
./METreformat/test/SL1L2.yaml
./METreformat/test/VCNT.yaml
./METreformat/test/CNT.yaml
./METreformat/test/FHO.yaml
./METreformat/test/CTS.yaml
./METreformat/test/PCT_ROC.yaml
./METreformat/test/ECNT.yaml
./METreformat/test/MCTS.yaml
./METreformat/test/RHIST.yaml
./METreformat/test/CTC.yaml
./METreformat/test/VL1L2.yaml
./METreformat/ECNT.yaml
./METreformat/reformat_stat.yaml
./.github/workflows/vulnerabilities.yaml
./.readthedocs.yaml

Time Estimate

1 to 3 days of work.

Sub-Issues

Consider breaking the task down into sub-issues.

[ ] Add a checkbox for each sub-issue here.

Relevant Deadlines

NONE

Funding Source

TBD

Define the Metadata

Assignee

[ ] Select engineer(s) or no engineer required
[ ] Select scientist(s) or no scientist required

Labels

[x] Select component(s)
[x] Select priority
[x] Select requestor(s)

Projects and Milestone

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

Define Related Issue(s)

Consider the impact to the other METplus components.

[ ] METplus, MET, METdataio, METviewer, METexpress, METcalcpy, METplotpy

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.
[ ] Add any new Python packages to the METplus Components Python Requirements table.
[ ] 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 Development 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.

mollybsmith-noaa commented 2 months ago

This is done for METdataio

JohnHalleyGotway commented 1 week ago

Please make this same change to the GitHub action workflow names in the main_v2.1 branch to make the GHA workflow dispatch options more clear.

jpresto$ find . -name "*yml"
./.github/workflows/release-checksum.yml
./.github/workflows/unit_tests.yml
./.github/workflows/trigger_metplus.yml
./.github/workflows/compare_db.yml
./.github/workflows/main.yml
./.github/workflows/documentation.yml

dtcenter / METdataio