ESMCI / ESMCI/manage_externals

Change a couple behaviors for optional externals

Open
#2 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
10
Forks
12
PR merge metrics
No merged PRs in 30d

Description

When "-o" isn't given that status of optional externals isn't reported on. I'd like to see a warning given that mentions these weren't checked out (at least for normal level of output logging).

I'd also like to see a README placed in the optional directory, that says (this directory wasn't checked out, please rerun checkout_externals at the top level with the "-o" option to make this happen if you need this directory).

I think the behavior should also be that if the directory doesn't exist it does the above creating the directory and adding a README file. But, if the directory does exist, it should ignore it (as presumably you ran checkout_externals with a "-o" option previously. But, it should normally print a warning if this is happening (for example "leaving the existing optional external directory tools/PTCLM since it already exists and you didn't specify the "-o" option).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the checkout_externals handling for the "-o" option and optional directories. Confirm how missing and existing optional directories are processed, then implement the requested warnings and README behavior. Done means normal output reports skipped externals and missing directories receive the specified README without overwriting existing directories.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.