d0c-s4vage / lookatme

An interactive, terminal-based markdown presenter

Home Page:https://lookatme.readthedocs.io/en/latest/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Update lookatme to use grapevine git tagging

d0c-s4vage opened this issue · comments

Describe the Feature Request

I don't know if this has another name, but I like to think of it as a grapevine.

Many aspects of lookatme are generated by the current state of the project:

  • The version number embedded in a few places
  • The current help text in the documentation
  • Changelog since the last version
  • etc.

These shouldn't be something that actually require a separate commit to update, but should be dynamically inserted into the code, with the updated code itself being treated as an artifact (having placeholders for the version number, help text, etc. be replaced by their current values).

It should go something like this:

    grapevine                  tag-the-current-state

       *                               *
       │ * v1.0.3                      │
       ├─┘                             *─ v1.0.3
       *                               *
       │                               │
       │ * v1.0.2                      │
       ├─┘              vs             *─ v1.0.2
       *                               *
       │                               │
       *                               *
       │ * v1.0.1                      │
       ├─┘                             *─ v1.0.2
       │                               │
       *                               *

Notice how the grapevine approach adds a separate commit that is not part of the main branch that contains the version of the code that has placeholders replaced with their current values.

Forgot to link the PR for this - this is done though. With #199