Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new 'last-edit' tour versioning scheme. #252

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Commits on Jul 29, 2022

  1. feat: Add new 'last-edit' tour versioning scheme.

    The Current Commit versioning strategy for tours is quite brittle, because it is
    based on commit hashes. The moment history gets rewritten by a rebase, the tour
    becomes untethered from the commit that we are trying to attach it to, because
    the commit hash that's recorded in the tour file no longer exists.
    
    Also, the Current Commit versioning strategy means that a tour commit must be in a
    separate commit, becuase the commit that it's attached to must already exist so
    that its hash can be recoreded in the `ref` field of the tour.
    
    Introduce a 'last-edit' versioning scheme. If the value of the ref is
    `'last-edit'`, then the tour is associated with the most recent commit that
    modifies the tour file.
    
    This will enable a code change and a tour which documents the code change to
    exist in the same commit. If during code review, the git history is rewritten by
    a rebase, the tour will still properly be associated with the correct commit.
    This should provide a far more robust and simpler user experience than the
    Current Commit versioning strategy.
    trcoffman committed Jul 29, 2022
    Configuration menu
    Copy the full SHA
    e094afc View commit details
    Browse the repository at this point in the history