Skip to content

Principles version in markdown may not match current revision viewed #20

@scottrigby

Description

@scottrigby

Good initial idea

The principles version was added to the header in markdown so that, when printed (and hung in every tech office in the world!), it will be clear which version of the principles is on view.

New problem

However, the problem is that in-between releases the last version is still part of the markdown header even as new changes are approved and merged into main. Take a look at this oneline commit history sample from today:

Screen Shot 2021-09-15 at 4 29 54 PM

You can see there are 4 commits after tag v0.1.0 which a user could view that still contain # GitOps Principles v0.1.0 at the top of PRINCIPLES.md.

Recommended fix

Remove principles version from header markdown in main to a separate commit in release branches. Can be manual at first then automated.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions