From c10ca83800323d20b82a4db5acf3af5dbd439096 Mon Sep 17 00:00:00 2001 From: Mirko Boehm Date: Thu, 19 Mar 2026 13:44:18 +0100 Subject: [PATCH] Add the 1.0.0 release announcement Closes #66 --- announcements/1.0-release.md | 50 ++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 announcements/1.0-release.md diff --git a/announcements/1.0-release.md b/announcements/1.0-release.md new file mode 100644 index 0000000..8dcae82 --- /dev/null +++ b/announcements/1.0-release.md @@ -0,0 +1,50 @@ +# shelldoc 1.0 Social Media Posts + +## LinkedIn + +shelldoc 1.0 is out! + +After three release candidates and six weeks of testing, shelldoc reaches its first stable release. shelldoc tests Unix shell commands embedded in your Markdown documentation, catching stale examples before they mislead your users. + +What shelldoc brings to the table: +- **Language-agnostic**: works with any Markdown docs, regardless of the project's language +- **Zero dependencies**: a single statically-linked binary, installed with `go install` +- **CI-friendly**: no Go toolchain needed at test time; drop the binary into any container +- **Dry-run mode** (`-n`): preview commands without executing them +- **Timeouts** (`-t`): prevent runaway tests, with per-block control via `shelldoctimeout` +- **JUnit XML output**: integrates test results into GitHub Actions and other CI workflows +- **License-safe**: shelldoc only tests your docs; its license never proliferates to your code + +1.0 adds a new logo and a thoroughly revised README that reflects the full, stable feature set. + +From here, shelldoc moves to semantic, on-demand releases. No more fixed RC cadence — new versions will ship when there is something worth shipping: a bug fix, a new feature, or a meaningful improvement. Follow the repository to stay current. + +Documentation lies — not intentionally, but code moves and docs lag. shelldoc closes that gap. + +Install: `go install github.com/mirkoboehm/shelldoc/cmd/shelldoc@latest` + +Project page: https://www.creative-destruction.org/project/shelldoc/ +GitHub: https://github.com/mirkoboehm/shelldoc + +#OpenSource #Documentation #DevTools #Golang + +--- + +## Mastodon + +shelldoc 1.0 is out! + +Six weeks, three release candidates, and one stable release. shelldoc tests shell commands in your Markdown docs so your examples stay honest. + +What's included: +- Single static binary, zero deps +- Dry-run mode (`-n`) and timeouts (`-t`) +- JUnit XML for CI integration +- New logo and revised docs +- Semantic, on-demand releases from here on + +`go install github.com/mirkoboehm/shelldoc/cmd/shelldoc@latest` + +https://github.com/mirkoboehm/shelldoc + +#OpenSource #Documentation #DevTools #Golang