specy_docs 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/README.md +42 -0
- data/lib/specy_docs/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bac5775174b86115593033bb7a3259e05dbfd3bb4633b885b0c78a2ef3f71df3
|
|
4
|
+
data.tar.gz: 8dcb5daaf051b624c428430a46aea685417aac30b7af94f8ed177166cf046742
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ad51f66dc77f01b04ebf76567884fc21e1883d0544cbb546564d903d478c4cec27ba4d6ae7f25a3d1eb93d29b5357130a3d6b5e8730b3f3f2e753e513ef18d76
|
|
7
|
+
data.tar.gz: c8c1f10244e78513862fac9b44244e7383242869a18b0764a6867a32b1d761a5ebf3c2eab0f7398e27fbae6a189bad18df9c7b8d5b4bc2e399bbc43fd337b088
|
data/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.1.1] - 2026-07-21
|
|
9
|
+
|
|
10
|
+
**Full Changelog**: https://github.com/thabotitus/specy_docs/commits/v0.1.1
|
|
11
|
+
|
|
8
12
|
## [0.1.0] - 2026-07-19
|
|
9
13
|
|
|
10
14
|
### Added
|
|
@@ -20,3 +24,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
20
24
|
- Support for API-only Rails apps (`config.api_only = true`)
|
|
21
25
|
|
|
22
26
|
[0.1.0]: https://github.com/thabotitus/specy_docs/releases/tag/v0.1.0
|
|
27
|
+
[0.1.1]: https://github.com/thabotitus/specy_docs/releases/tag/v0.1.1
|
data/README.md
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
# SpecyDocs
|
|
2
2
|
|
|
3
3
|
Capture RSpec request examples and serve a mountable docs UI.
|
|
4
|
+
- Use it if you want readable low-config docs for your team.
|
|
5
|
+
- Use it to uncover endpoints that you may not know exist.
|
|
6
|
+
- 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.
|
|
4
7
|
|
|
5
8
|
## Installation
|
|
6
9
|
|
|
@@ -131,3 +134,42 @@ end
|
|
|
131
134
|
## Notes for API-only apps
|
|
132
135
|
|
|
133
136
|
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`.
|
|
137
|
+
|
|
138
|
+
## Releasing
|
|
139
|
+
|
|
140
|
+
Releases are prepared locally and published by GitHub Actions when you publish the draft GitHub release.
|
|
141
|
+
|
|
142
|
+
### One-time setup
|
|
143
|
+
|
|
144
|
+
1. Create a RubyGems API key with **Push rubygem** permission.
|
|
145
|
+
2. Add it as a repository secret named `RUBYGEMS_API_KEY`.
|
|
146
|
+
3. Ensure a long-lived `release` branch exists (or let `bin/release` create it on first run).
|
|
147
|
+
|
|
148
|
+
### Cut a release
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
bin/release
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
You will be prompted for bump type (patch / minor / major). Release notes are
|
|
155
|
+
generated from commits via the GitHub API (same source as GitHub auto notes),
|
|
156
|
+
previewed for confirmation, then written into `CHANGELOG.md` and the draft release.
|
|
157
|
+
|
|
158
|
+
The script will:
|
|
159
|
+
|
|
160
|
+
1. Fetch remotes and tags
|
|
161
|
+
2. Check out `release` and merge `origin/main`
|
|
162
|
+
3. Generate release notes from commits since the previous tag
|
|
163
|
+
4. Bump `lib/specy_docs/version.rb` and prepend those notes to `CHANGELOG.md`
|
|
164
|
+
5. Commit, tag (`vX.Y.Z`), and push `release` + the tag
|
|
165
|
+
6. Create a **draft** GitHub release with the same notes
|
|
166
|
+
|
|
167
|
+
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`.
|
|
168
|
+
|
|
169
|
+
Preview without changing anything:
|
|
170
|
+
|
|
171
|
+
```bash
|
|
172
|
+
bin/release --dry-run
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Requires a clean working tree, `gh` authenticated to the repo, and push access to `origin`.
|
data/lib/specy_docs/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: specy_docs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Thabo Titus
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-07-
|
|
11
|
+
date: 2026-07-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rails
|
|
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
71
71
|
- !ruby/object:Gem::Version
|
|
72
72
|
version: '0'
|
|
73
73
|
requirements: []
|
|
74
|
-
rubygems_version: 3.5.
|
|
74
|
+
rubygems_version: 3.5.22
|
|
75
75
|
signing_key:
|
|
76
76
|
specification_version: 4
|
|
77
77
|
summary: Mountable API docs generated from RSpec request captures
|