[MISC] The Version Checker

Open
#31 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
cpp
Domain
cli

Research direction

No files, tests, or entry points are named. First review the existing version-checker implementation and the changes from #38 and #83, then determine the current SeqAn and sharg version-reporting paths. The open work is to define behavior for sharg-only use and the future SeqAn3 integration, including the CI check and notification rules.

Written by the indexing model from the issue text.

Description

SeqAn behaviour (current):

app user = e.g. someone using raptor
app developerr = e.g. Enrico

Call server with current seqan version and current app version. And then:

  1. Notify user if there is a newer app version
  2. Notify app developer if there is a newer SeqAn version than the current
  3. Notify app developer if current app version is newer than the one registered online

I think 1. and 3. can stay as is.

**But what to do about 2. **

a. Do we notify about the sharg version instead? (I guess)
b. But: What happens when we include sharg back in seqan3. Do we still report the sharg version? Since seqan3 would need to update sharg not the app developer using seqan3. Then it's more interesting to update seqan3?

For now we could implement a) and worry about b) when we backport sharg to seqan3.

  • Alter version checker when only using sharg, to call the sharg version
    • Done by #38
      Open Todo:
    • #83
  • When we backport sharg to seqan3 we need to
    • call sharg and seqan3 version
    • user should ONLY be notified about a seqan3 version now, NOT sharg
    • Our CI should check if seqan3 includes the newest sharg
    • The unusal use case, that sharg AND seqan3 are included will be solved by customising the submodules dir
Dominant language
C++
Stars
11
Forks
9
Avg merge
2h 33m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from seqan/sharg-parser

All issues in seqan/sharg-parser

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.