search

nasa / cFE

The Core Flight System (cFS) Core Flight Executive (cFE)
Apache License 2.0
408 stars 200 forks source link

Limit dynamically-obtained version info to tags starting with "v" #1238

Open jphickey opened 3 years ago

jphickey commented 3 years ago

Is your feature request related to a problem? Please describe. Tags may be created in the git repo for a number of reasons, not just releases/prereleases, and it is helpful to have the option of also making an annotated tag too so it can have a real description attached to it.

But in that case the tag will be picked up by git describe which is what is used by default for dynamically obtained version info shown at runtime.

Describe the solution you'd like Version tags in the CFE framework and CFS apps all follow the general pattern of vX.X.X. So if the dynamic version info is limited to tags that start with v (maybe also a number to be real specific) this should effectively make it so extra snapshot tags will not be considered - so long as they don't start with v.

Describe alternatives you've considered Use annotated tags only for those that should be considered baselines, and only use non-annotated tags for any other snapshots.

Additional context Users can still customize this git describe if they happen to use some other tagging pattern/convention. But all the framework stuff already uses the v convention.

Requester Info Joseph Hickey, Vantage Systems, Inc.

jphickey commented 3 years ago

This is pretty easy to implement - just add a --match 'v[0-9]' option to the git describe command to limit it to this pattern. This does assume/require that any other general purpose snapshots/non-baseline tags would employ a pattern that does not start with v.

First posing this as a question to get buy-in and then I can easily make this change.