DOI-USGS / DOI-USGS/scipiper

Message when scipiper version changes

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

Description

We've hit an issue where some team members have updated scipiper and others have not, and when one team member builds a task table, other team members may see the results as out of date due to a different hash of the task table yml file.

One solution is to give a warning when scipiper version has changed. This could happen right when you load scipiper - we could look in the current working directory for .yml files, see if any of them have a line like
```yml
# using scipiper package version 0.0.16
```
and then give a warning if the package version noted there differs from scipiper's current version.

Alternatively, if our problem is truly just with hashes of the automatically generated task-table yml files, maybe we should leave out that package version info from the task-table ymls.

Contributor guide

Open the contributing guide

Research direction

Start with scipiper loading, the current working directory's .yml files, and generated task-table YAML handling. Resolve whether a version-change warning or hash exclusion is intended; done means one behavior is specified and its effect on out-of-date results is verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.