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

Stable tagging process for this repository is different from workstation-docs #621

Open
legoktm opened this issue Dec 20, 2024 · 3 comments

Comments

@legoktm
Copy link
Member

legoktm commented Dec 20, 2024

Describe the change

In this repository we promote docs to stable by pushing a new versioned tag. In the workstation-docs repository we force-push a "stable" tag.

@nathandyer suggested that we should standardize on one scheme.

@legoktm legoktm moved this to Cycle Backlog in SecureDrop dev cycle Dec 20, 2024
@legoktm
Copy link
Member Author

legoktm commented Dec 20, 2024

My initial reaction is that force-pushing tags is kind of heretical because tags are supposed to point to a fix commit, forever and would prefer using plain version numbers. But I cannot articulate any reason why that's better functionally vs just having a moving stable tag.

@cfm
Copy link
Member

cfm commented Dec 20, 2024

For a system (or library) that actively supports non-latest versions, having version-tagged documentation makes sense. We really don't. All else being equal, I favor keeping the documentation-publishing process as simple as possible, which I think argues for a stable tag versus everything else.

@eloquence
Copy link
Member

eloquence commented Jan 3, 2025

Over on the web repos we use date-based tags like 2024.12.02, with a suffix like -2 if there is more than one deploy in a day.

A deployment-based semantic could make sense here as well; it would decouple the notion of "stable documentation" explicitly from a release version, but allow us to keep track of when stable deploys took place using git.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Cycle Backlog
Development

No branches or pull requests

3 participants