Script to automate RTD config file update #59
Conversation
eirikurj
requested review from
A-CGray and
marcomangano
and removed request for
a team
| REPODIR="$WORKDIR/$repo" | ||
| echo "Updating $repo" | ||
| git clone git@github.com:mdolab/"$repo".git | ||
| cd $REPODIR |
There was a problem hiding this comment.
I would have a safety check here to make sure that if a repo is missing from the list, we just move on to the next repo instead of exiting.
There was a problem hiding this comment.
Added some safeguards by checking exit conditions
| echo "Updating $repo" | ||
| git clone git@github.com:mdolab/"$repo".git | ||
| cd $REPODIR | ||
| git checkout -b $BRANCH_NAME |
There was a problem hiding this comment.
similar here, if for any reason we already have a branch with that name, I would add a check (or maybe a user prompt?) on whether to continue or not
There was a problem hiding this comment.
Added some safeguards by checking exit conditions
rtd/updateYaml.sh
Outdated
| # Init array to track progress | ||
| declare -A REPO_STATUS | ||
|
|
||
| repoFailed () { |
There was a problem hiding this comment.
Is this function being used?
There was a problem hiding this comment.
Good catch, I was going to use it, but decided not to in the end. Just moved the error echo instead. Should be good now.
|
If no one else has comments, I will merge this tomorrow morning. |
| if [[ -z $MANUAL_REPO && -z $REPO_LIST ]]; then | ||
| echo "Insufficient inputs, see usage:" | ||
| echo "$USAGE" | ||
| die |
Purpose
This PR adds an initial script that can be used to automate the update of RTD config files for a number of our repositories. The idea is to minimize the maintenance needed managing this particular file until some other solution, such as templating, is supported (see https://github.com/mdolab/private-docs/issues/298 for some discussion). If not, we could improve on this later by automatically generating the
yamlfile.Expected time until merged
No rush
Type of change
Testing
Checklist
flake8andblackto make sure the Python code adheres to PEP-8 and is consistently formattedfprettifyor C/C++ code withclang-formatas applicable