Skip to content

Remove date tag from generated docs to reduce git churn#532

Merged
irees merged 3 commits intomainfrom
remove-date-tag
Dec 5, 2025
Merged

Remove date tag from generated docs to reduce git churn#532
irees merged 3 commits intomainfrom
remove-date-tag

Conversation

@irees
Copy link
Copy Markdown
Contributor

@irees irees commented Dec 5, 2025

No description provided.

Copilot AI review requested due to automatic review settings December 5, 2025 02:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes auto-generated date timestamps from CLI documentation files to reduce unnecessary git churn. The spf13/cobra library adds an auto-generation tag with a date stamp to generated markdown documentation, which causes these files to be marked as changed every time the documentation is regenerated, even when there are no meaningful content changes. By setting DisableAutoGenTag: true on the root cobra command, the date-stamped footer is no longer added to generated documentation files.

Key Changes:

  • Added DisableAutoGenTag: true to the root cobra.Command configuration
  • Removed existing auto-generated date tags from all 26 CLI documentation files

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated no comments.

File Description
cmd/transitland/main.go Added DisableAutoGenTag: true to rootCmd to prevent future generation of date-stamped tags
doc/cli/*.md (26 files) Removed existing auto-generated date tag footers (e.g., "###### Auto generated by spf13/cobra on 21-Oct-2025")

The implementation is correct and comprehensive. All documentation files have been consistently updated, and the root command has been properly configured to prevent these tags from being regenerated in the future.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@irees irees merged commit 4e80fb6 into main Dec 5, 2025
6 checks passed
@irees irees deleted the remove-date-tag branch December 5, 2025 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants