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

Consider using only .yml or only .yaml extensions #272

Open
3 of 22 tasks
jprestop opened this issue Feb 2, 2024 · 2 comments · Fixed by #314 or #313
Open
3 of 22 tasks

Consider using only .yml or only .yaml extensions #272

jprestop opened this issue Feb 2, 2024 · 2 comments · Fixed by #314 or #313
Assignees
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: code cleanup Code cleanup and maintenance issue priority: low Low Priority requestor: METplus Team METplus Development Team type: task An actionable item of work

Comments

@jprestop
Copy link
Collaborator

jprestop commented Feb 2, 2024

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

  • Select component(s)
  • Select priority
  • 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.

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.
@jprestop jprestop added alert: NEED ACCOUNT KEY Need to assign an account key to this issue priority: low Low Priority type: task An actionable item of work component: code cleanup Code cleanup and maintenance issue requestor: METplus Team METplus Development Team labels Feb 2, 2024
@jprestop jprestop added this to the METdataio-3.0.0 milestone Feb 2, 2024
@hankenstein2 hankenstein2 self-assigned this Feb 28, 2024
@mollybsmith-noaa
Copy link
Contributor

This is done for METdataio

This was linked to pull requests Jun 28, 2024
@JohnHalleyGotway
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: code cleanup Code cleanup and maintenance issue priority: low Low Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
Status: 🏁 Done
Development

Successfully merging a pull request may close this issue.

5 participants