d0c-s4vage / lookatme

An interactive, terminal-based markdown presenter
https://lookatme.readthedocs.io/en/latest/
MIT License
2.06k stars 59 forks source link

Update lookatme to use grapevine git tagging #198

Closed d0c-s4vage closed 1 year ago

d0c-s4vage commented 1 year ago

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:

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.

d0c-s4vage commented 1 year ago

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