specy_docs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f5818e923a111c6ea1eea3993742da3e1e273f730001a9001b643a9b0bb0308
-  data.tar.gz: 170add497082a8e34fd9a58fb4e3fa29db0758c3f0989140b8222f2f1cde253c
+  metadata.gz: bac5775174b86115593033bb7a3259e05dbfd3bb4633b885b0c78a2ef3f71df3
+  data.tar.gz: 8dcb5daaf051b624c428430a46aea685417aac30b7af94f8ed177166cf046742
 SHA512:
-  metadata.gz: 9d9f5595c0f2d424c51364bbe0b5611a511dd4173c607be7c2d83f7ea3d80c3e65286cd15b85a1c30b84ccdd8eac4217b820f272451821dd5590948051f7dd2e
-  data.tar.gz: 94823fe80e78e972da517fbe771b5fdededd227d4006c4c63112352858c9daac39440fd0e9c9c18b06321c2b5fcab72f56cf27203af13e10239025d86ff75d97
+  metadata.gz: ad51f66dc77f01b04ebf76567884fc21e1883d0544cbb546564d903d478c4cec27ba4d6ae7f25a3d1eb93d29b5357130a3d6b5e8730b3f3f2e753e513ef18d76
+  data.tar.gz: c8c1f10244e78513862fac9b44244e7383242869a18b0764a6867a32b1d761a5ebf3c2eab0f7398e27fbae6a189bad18df9c7b8d5b4bc2e399bbc43fd337b088

data/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.1] - 2026-07-21
+
+**Full Changelog**: https://github.com/thabotitus/specy_docs/commits/v0.1.1
+
 ## [0.1.0] - 2026-07-19
 
 ### Added
@@ -20,3 +24,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for API-only Rails apps (`config.api_only = true`)
 
 [0.1.0]: https://github.com/thabotitus/specy_docs/releases/tag/v0.1.0
+[0.1.1]: https://github.com/thabotitus/specy_docs/releases/tag/v0.1.1

data/README.md

@@ -1,6 +1,9 @@
 # SpecyDocs
 
 Capture RSpec request examples and serve a mountable docs UI.
+  - Use it if you want readable low-config docs for your team.
+  - Use it to uncover endpoints that you may not know exist. 
+  - Use it if swagger and the hoops you have to jump are annoying, when you just want to show teams how to use your API with your tested code.
 
 ## Installation
 
@@ -131,3 +134,42 @@ end
 ## Notes for API-only apps
 
 SpecyDocs loads Action Controller and Action View railties inside the engine, so the UI renders even when the host app uses `config.api_only = true`.
+
+## Releasing
+
+Releases are prepared locally and published by GitHub Actions when you publish the draft GitHub release.
+
+### One-time setup
+
+1. Create a RubyGems API key with **Push rubygem** permission.
+2. Add it as a repository secret named `RUBYGEMS_API_KEY`.
+3. Ensure a long-lived `release` branch exists (or let `bin/release` create it on first run).
+
+### Cut a release
+
+```bash
+bin/release
+```
+
+You will be prompted for bump type (patch / minor / major). Release notes are
+generated from commits via the GitHub API (same source as GitHub auto notes),
+previewed for confirmation, then written into `CHANGELOG.md` and the draft release.
+
+The script will:
+
+1. Fetch remotes and tags
+2. Check out `release` and merge `origin/main`
+3. Generate release notes from commits since the previous tag
+4. Bump `lib/specy_docs/version.rb` and prepend those notes to `CHANGELOG.md`
+5. Commit, tag (`vX.Y.Z`), and push `release` + the tag
+6. Create a **draft** GitHub release with the same notes
+
+Then open the draft on GitHub, review the notes, and click **Publish release**. That triggers `.github/workflows/publish-gem.yml`, which builds the gem and runs `gem push`.
+
+Preview without changing anything:
+
+```bash
+bin/release --dry-run
+```
+
+Requires a clean working tree, `gh` authenticated to the repo, and push access to `origin`.

data/lib/specy_docs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SpecyDocs
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: specy_docs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Thabo Titus
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-19 00:00:00.000000000 Z
+date: 2026-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Mountable API docs generated from RSpec request captures