Skip to content

docs(api-only-transcriberj-restdocs): describe the emitter as released - #91

Merged
Arc-E-Tect merged 1 commit into
mainfrom
docs/restdocs-readme-release-state
Sep 18, 2026
Merged

Arc-E-Tect merged 1 commit into
mainfrom
docs/restdocs-readme-release-state

Conversation

@Arc-E-Tect

Copy link
Copy Markdown
Owner

The emitter's README still described it as unreleased.

  • Removed "Not released yet." It is at 0.1.1.
  • The TranscriberJ requirement said "the version this emitter was built against, 0.0.0 until both are released". It now says 0.3.0 or newer: the emitter is built against 0.3.0 (gradle/libs.versions.toml), and the examples use it with 0.3.3. It also says that until the TranscriberJ reaches 1.0.0, a release may change the emitter interface.
  • The "Using it" snippet named <version>. It now names 0.1.1, which the release workflow's existing sed (api-only-transcriberj-restdocs:X.Y.Z) keeps current. I tested that substitution on the new text.

This is README-only, and the emitter's release workflow doesn't trigger on README changes, so merging releases nothing.

Found while writing the reference on authoring a specification library (API #28).

The README still said 'Not released yet', and that the TranscriberJ it
needs is '0.0.0 until both are released'. The emitter is at 0.1.1; it is
built against TranscriberJ 0.3.0 and used with 0.3.3 in the examples.
The Using-it snippet now names the version instead of <version>, which
the release workflow's existing substitution keeps current.
@Arc-E-Tect
Arc-E-Tect merged commit d294fc3 into main Sep 18, 2026
4 checks passed
@Arc-E-Tect
Arc-E-Tect deleted the docs/restdocs-readme-release-state branch September 18, 2026 16:13
@Arc-E-Tect

Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@Arc-E-Tect

Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 1.0.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Arc-E-Tect added a commit that referenced this pull request Sep 26, 2026
# [0.2.0](api-only-transcriberj-restdocs-v0.1.1...api-only-transcriberj-restdocs-v0.2.0) (2026-09-26)

### ✨ New and updated features

* **api-only-transcriberj-restdocs:** render invalid-request cases as REST Docs contract tests ([#103](#103)) ([f6652b8](f6652b8)), closes [#103](#103) [#32](#32)

### 📝 Documentation

* correct what the Microcks emitter's documentation claims, and list it in the root README ([#97](#97)) ([4a22930](4a22930)), closes [#97](#97)
* **api-only-transcriberj-restdocs:** describe the emitter as released ([#91](#91)) ([d294fc3](d294fc3)), closes [#91](#91)
* **api-only-transcriberj-restdocs:** update README version to 0.1.1 [skip ci] ([dd5093f](dd5093f))
@Arc-E-Tect

Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 0.2.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@Arc-E-Tect

Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 1.0.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@Arc-E-Tect

Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 1.0.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant