cmake: Make git describe handle non-annotated tags

[galak]

If we tag via github a pre-release we don't get an annotated tag. So
the BUILD_VERSION isn't reported correctly. We can fix this via adding
--tags to 'git describe'.

Fixes #14985

Signed-off-by: Kumar Gala [email protected]

[nashif]

Do we want to allow non-annotated tags for the releases? I would fix the tag that was created already as non-annotated instead and make sure we create the tags on the command line in the future instead of using github.

[marc-hb]

Agree with @nashif , a release shouldn't be based on a light-weight tag which doesn't even have an author's name. git help tag:

Annotated tags are meant for release while lightweight tags are meant for private or temporary object labels. For this reason, some git commands for naming objects (like git describe) will ignore lightweight tags by default.

Linux kernel release are based on --sign ed tags.

I'm surprised github lets people create releases based on a light-weight tag, does it?

Now you could still want describe --tag for other reasons (I don't), but not to create a release and fix issue #14985 Hopefully you can just delete the v1.14-N light-weight tag.

[codecov-io]

Codecov Report

❗ No coverage uploaded for pull request base (master@672607c). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master   #14986   +/-   ##
=========================================
  Coverage          ?   52.92%           
=========================================
  Files             ?      309           
  Lines             ?    45266           
  Branches          ?    10451           
=========================================
  Hits              ?    23955           
  Misses            ?    16543           
  Partials          ?     4768

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 672607c...7be80cb. Read the comment docs.

[galak]

Closing this, agreed we should tag by hand to get annotated tags.