Deprecate tfproviderdocs in favor of swissshepherd

.github/workflows/release.yml

@@ -64,10 +64,6 @@ jobs:
           gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.GPG_PASSPHRASE }}
 
-      - name: Generate release notes
-        run: |
-          sed -n -e "1{/# v/d;}" -e "2{/^$/d;}" -e "/# $(git describe --abbrev=0 --exclude="$(git describe --abbrev=0 --match='v*.*.*' --tags)" --match='v*.*.*' --tags)/q;p" CHANGELOG.md > RELEASE-NOTES.md
-
       - name: Check configuration
         uses: goreleaser/goreleaser-action@ec59f474b9834571250b370d4735c50f8e2d1e29 # v7.0.0
         with:
@@ -84,4 +80,4 @@ jobs:
           GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
           RELEASE_TAG: ${{ env.RELEASE_TAG }}
         with:
-          args: release --release-notes RELEASE-NOTES.md --clean
+          args: release --clean

AGENTS.md

@@ -2,6 +2,13 @@
 <!-- Copyright IBM Corp. 2019, 2026 -->
 <!-- SPDX-License-Identifier: MPL-2.0 -->
 
+> ## ⚠️ Deprecated
+>
+> `tfproviderdocs` is deprecated and no longer maintained. All functionality
+> has been superseded by [swissshepherd](https://github.com/YakDriver/swissshepherd).
+> New work should target swissshepherd; this repository will receive no
+> further releases or bug fixes.
+
 ## Project Purpose & Usage
 `tfproviderdocs` operates as a CI/CD safeguard for Terraform providers, validating user-facing docs for required structure, headings, and metadata. When supplied a provider schema in JSON (via `terraform providers schema -json`), it cross-references expected data sources and resources so engineers do not hand-maintain checklists. Providers such as AWS invoke the tool within release pipelines, for example:
 

CHANGELOG.md

@@ -1,3 +1,12 @@
 # CHANGELOG
 
+## Deprecated — 2026-06-11
+
+`tfproviderdocs` is deprecated and no longer maintained. All functionality has
+been superseded by [swissshepherd](https://github.com/YakDriver/swissshepherd).
+No further releases or bug fixes will be made to this project. Please migrate
+to swissshepherd.
+
+---
+
 See the [release notes](https://github.com/YakDriver/tfproviderdocs/releases) for each release.

README.md

@@ -2,6 +2,13 @@
 <!-- Copyright IBM Corp. 2019, 2026 -->
 <!-- SPDX-License-Identifier: MPL-2.0 -->
 
+> ## ⚠️ Deprecated
+>
+> **`tfproviderdocs` is deprecated and no longer maintained.** All functionality
+> has been superseded by [**swissshepherd**](https://github.com/YakDriver/swissshepherd).
+> Please migrate to swissshepherd; this repository will receive no further
+> releases or bug fixes.
+
 A documentation tool for [Terraform Provider](https://www.terraform.io/docs/providers/index.html) code.
 
 ## Install

check/contents/doc.go

@@ -0,0 +1,11 @@
+// Copyright IBM Corp. 2019, 2026
+// SPDX-License-Identifier: MPL-2.0
+
+// Package contents validates the body of individual Terraform Provider
+// documentation files: headings, sections, schema attribute lists, and
+// related content rules.
+//
+// Deprecated: tfproviderdocs is no longer maintained. All functionality has
+// been superseded by github.com/YakDriver/swissshepherd. Please migrate:
+// https://github.com/YakDriver/swissshepherd
+package contents

check/doc.go

@@ -0,0 +1,10 @@
+// Copyright IBM Corp. 2019, 2026
+// SPDX-License-Identifier: MPL-2.0
+
+// Package check verifies the structure and contents of Terraform Provider
+// documentation directories and files.
+//
+// Deprecated: tfproviderdocs is no longer maintained. All functionality has
+// been superseded by github.com/YakDriver/swissshepherd. Please migrate:
+// https://github.com/YakDriver/swissshepherd
+package check

command/doc.go

@@ -0,0 +1,10 @@
+// Copyright IBM Corp. 2019, 2026
+// SPDX-License-Identifier: MPL-2.0
+
+// Package command implements the tfproviderdocs CLI subcommands (check and
+// version) consumed by main.
+//
+// Deprecated: tfproviderdocs is no longer maintained. All functionality has
+// been superseded by github.com/YakDriver/swissshepherd. Please migrate:
+// https://github.com/YakDriver/swissshepherd
+package command

go.mod

@@ -1,3 +1,6 @@
+// Deprecated: tfproviderdocs is no longer maintained. All functionality has
+// been superseded by github.com/YakDriver/swissshepherd. Please migrate:
+// https://github.com/YakDriver/swissshepherd
 module github.com/YakDriver/tfproviderdocs
 
 go 1.25.5

main.go

@@ -1,10 +1,16 @@
 // Copyright IBM Corp. 2019, 2026
 // SPDX-License-Identifier: MPL-2.0
 
+// Command tfproviderdocs validates Terraform provider documentation.
+//
+// Deprecated: tfproviderdocs is no longer maintained. All functionality has
+// been superseded by swissshepherd. Please migrate to:
+// https://github.com/YakDriver/swissshepherd
 package main
 
 import (
 	"fmt"
+	"io"
 	"os"
 
 	"github.com/YakDriver/tfproviderdocs/command"
@@ -18,6 +24,8 @@ const (
 )
 
 func main() {
+	printDeprecationNotice(os.Stderr)
+
 	ui := &cli.ColoredUi{
 		ErrorColor: cli.UiColorRed,
 		WarnColor:  cli.UiColorYellow,
@@ -45,3 +53,14 @@ func main() {
 
 	os.Exit(exitStatus)
 }
+
+// printDeprecationNotice writes a deprecation banner to the given writer
+// (typically os.Stderr) so it does not pollute stdout consumed by CI parsers.
+func printDeprecationNotice(w io.Writer) {
+	fmt.Fprintln(w, "============================================================")
+	fmt.Fprintln(w, "DEPRECATED: tfproviderdocs is no longer maintained.")
+	fmt.Fprintln(w, "All functionality has been superseded by swissshepherd:")
+	fmt.Fprintln(w, "    https://github.com/YakDriver/swissshepherd")
+	fmt.Fprintln(w, "Please migrate. This tool will receive no further releases.")
+	fmt.Fprintln(w, "============================================================")
+}

markdown/doc.go

@@ -0,0 +1,10 @@
+// Copyright IBM Corp. 2019, 2026
+// SPDX-License-Identifier: MPL-2.0
+
+// Package markdown provides Markdown parsing helpers (built on goldmark)
+// used by the documentation checks.
+//
+// Deprecated: tfproviderdocs is no longer maintained. All functionality has
+// been superseded by github.com/YakDriver/swissshepherd. Please migrate:
+// https://github.com/YakDriver/swissshepherd
+package markdown

version/doc.go

@@ -0,0 +1,9 @@
+// Copyright IBM Corp. 2019, 2026
+// SPDX-License-Identifier: MPL-2.0
+
+// Package version exposes build-time version information for tfproviderdocs.
+//
+// Deprecated: tfproviderdocs is no longer maintained. All functionality has
+// been superseded by github.com/YakDriver/swissshepherd. Please migrate:
+// https://github.com/YakDriver/swissshepherd
+package version

version/version.go

@@ -14,7 +14,7 @@ var (
 	GitDescribe string
 
 	// The main version number that is being run at the moment.
-	Version = "0.25.0"
+	Version = "0.26.0"
 
 	// A pre-release marker for the version. If this is "" (empty string)
 	// then it means that it is a final release. Otherwise, this is a pre-release