Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions announcements/1.0-release.md
Original file line number Diff line number Diff line change
@@ -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
Loading