Deprecate tfproviderdocs in favor of swissshepherd - #400
Merged
Conversation
YakDriver
commented
Jun 11, 2026
YakDriver
commented
Owner
- Remove broken token-expiration workflow
- Deprecate tfproviderdocs in favor of swissshepherd
The workflow checked a hard-coded TOKEN_EXPIRATION_DATE of 2025-12-01. That date has since passed, so DAYS_LEFT is now negative and the "-le 7" check is permanently true, causing a fresh "YAKBOT_GITHUB_TOKEN Expiration Alert" issue to be filed every day at midnight. The token itself is no longer needed, so delete the workflow rather than refresh the date.
All functionality of tfproviderdocs has been superseded by github.com/YakDriver/swissshepherd. Announce deprecation across every surface a user, contributor, or downstream tool is likely to read: - README.md: prominent⚠️ Deprecated banner above the title. - AGENTS.md: matching banner for contributors and AI agents. - CHANGELOG.md: dated "Deprecated — 2026-06-11" entry. - main.go: package-level "// Deprecated:" doc comment, plus a printDeprecationNotice helper invoked at startup that writes a banner to stderr (keeps stdout clean for CI parsers). - go.mod: canonical Go module deprecation comment block above the module directive, so "go list -m -u" and "go get" surface a warning to consumers (https://go.dev/ref/mod#go-mod-file-module-deprecation). No functional changes to the check command itself; existing tests still pass.
YakDriver
changed the title
Add a doc.go to each subpackage (check, check/contents, command, markdown, version) carrying the canonical Go package doc comment plus a "Deprecated:" paragraph. Picked up by go doc, pkg.go.dev, and gopls hovers, so any (rare) library importer of these packages sees the deprecation in their tooling. Complements the existing module-level deprecation in go.mod and the package doc on main.go.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.