dev_onboarder 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a976b60fbd1fdf065d23f456c7e8748e3d9a14431355386c8b7e7b55465af4fc
-  data.tar.gz: 7dfbe87e983559d84a811fb9c87dceb0f74c9d1929a082c20310f13969b0a2ce
+  metadata.gz: 5fec77b9c95e58e082ed3fea9246db9b2241960f938b52a76180a1a8e339b7a8
+  data.tar.gz: 783c8b0d638e93c3ab1aae29cf367a55c42467eacf905a35c99f92ea4225e8d8
 SHA512:
-  metadata.gz: 8e0b84e69b5b6dbe02339487cefcea0f7a0d95b5c9f3e687d799b19dcac07da0d37d547ef98fe59b9aac924487e78047785c1eb6a0e03d55992d8954fd578025
-  data.tar.gz: 8d6503b8bc9d9a4d4a2d177d17979723191a4feb3342da456aeb9181e70f0923498b003feb11c7db54169dc4d547a727b38340bfb13bf22349615ed328009524
+  metadata.gz: e4673663a7339b9cbaf6b50eda4ff7690d89a26b5300b2927c9aaeeb6f14e9dd3408dc463632aaaa87e11a512235ebda61a71184ca957d4f183cf0155f70f56f
+  data.tar.gz: db4001553801d75a7302d3dfb4cb5fdafd202607527d57d843e74ea95747c987b21d769114f5c59c42c9d83b69d626abfe6cc35cf1fca5af6434fa8b9d0d21e0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.9.1]
+
+- The README and the install local add the gem from RubyGems.
+
 ## [0.9.0]
 
 - The gem is a the_local provider: a host that runs `the_local install` gets info, install and develop locals for the setup tool.

data/README.md

@@ -4,7 +4,7 @@ One setup command that gets a developer from a fresh clone to a working repo.
 
 ## Install
 
-Add the gem to the repo's `Gemfile` and run `bundle install`, then write a `Setupfile`. Nothing else in
+Add `gem "dev_onboarder", "~> 0.9"` to the repo's `Gemfile` and run `bundle install`, then write a `Setupfile`. Nothing else in
 the repo changes: the gem adds no line to its routes, boot code, initializers or `.gitignore`.
 
 ## Declare what the repo needs

data/lib/dev_onboarder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DevOnboarder
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/the_local/agents/dev_onboarder-develop.md

@@ -101,9 +101,9 @@ A gem that reads a `Setupfile` at the repo's root, checks each requirement it de
 
    - `bundle exec dev_onboarder setup payments` checks, fixes and asks for only that feature's requirements, and exits non-zero when any required one of them is not met. An unknown name prints `No feature named <name>.` and exits non-zero.
    - `bundle exec dev_onboarder status` lists each requirement that is new, changed or was left not met, with a feature's requirements under its name. A requirement counts as changed when its check, fix or instruction changes. With nothing to list it prints `Nothing has changed since your last setup.` It exits non-zero only when a required requirement outside a feature is listed.
-   - `bundle exec dev_onboarder features` lists each feature as ready or not ready. A feature is not ready when any of its requirements is new, changed or not met. It exits zero whenever the `Setupfile` loads.
+   - `bundle exec dev_onboarder features` lists each feature as ready or not ready. A feature is not ready when any of its requirements, optional ones included, is new, changed or not met. It exits zero whenever the `Setupfile` loads.
 
-9. In a Rails app that has keystone_ui, point the developer to `/dev_onboarder` on the locally running app. It shows every requirement by group with its state and last check, each feature and whether it is ready, and the command to run. It reads the last recorded run and runs no check and no fix, so a change to the `Setupfile` appears there only after a command has run. An error in the `Setupfile` is shown on the page as a warning. When the server starts locally, its output carries one line when any requirement outside a feature is new, changed or not met.
+9. In a Rails app that has keystone_ui, point the developer to `/dev_onboarder` on the locally running app. It shows every requirement by group with its state and last check, each feature and whether it is ready, and the command to run. It reads the current `Setupfile` and the last recorded run, and runs no check and no fix, so a requirement added to the `Setupfile` shows as new there until a command has run. An error in the `Setupfile` is shown on the page as a warning. When the server starts locally, its output carries one line when any requirement outside a feature is new, changed or not met.
 
 ## Conventions
 

data/the_local/agents/dev_onboarder-install.md

@@ -13,17 +13,17 @@ A gem that checks and fixes what a repo needs to run, hooked into any repo that
 
 ## Interface
 
-- `gem "dev_onboarder", github: "DYB-Development/dev_onboarder", tag: "v0.9.0"` — the `Gemfile` line that adds the gem to the repo.
+- `gem "dev_onboarder", "~> 0.9"` — the `Gemfile` line that adds the gem to the repo from RubyGems.
 - `DevOnboarder.base_controller` — the name of the controller the setup page inherits from, given as a string, in a Rails app with keystone_ui only.
 
 ## How to use it
 
-1. Read the repo's `Gemfile`. If it already has a `dev_onboarder` line, stop and tell the developer which version it names.
+1. Read the repo's `Gemfile`. If it already has a `dev_onboarder` line that names `github:`, replace that line with the line in step 3, keeping its group, and go to step 4. If it has any other `dev_onboarder` line, stop and tell the developer which version it names.
 2. Ask the developer which Gemfile group the gem goes in: the default group, or `group: :development`. In the default group, the setup page also exists when the app runs in test. In `group: :development`, the gem is not loaded in test or production.
 3. Add this line to the `Gemfile`, in the group the developer chose:
 
    ```ruby
-   gem "dev_onboarder", github: "DYB-Development/dev_onboarder", tag: "v0.9.0"
+   gem "dev_onboarder", "~> 0.9"
    ```
 
 4. Run `bundle install`. It updates `Gemfile.lock`. No other file in the repo is created or edited: no route, no initializer, no boot code, no `.gitignore` line.
@@ -37,11 +37,11 @@ A gem that checks and fixes what a repo needs to run, hooked into any repo that
 
 ## Conventions
 
-- Confirm the install with `bundle info dev_onboarder`, which prints version 0.9.0.
+- Confirm the install with `bundle info dev_onboarder`, which prints a version of 0.9.0 or later and below 1.0.
 - In a Rails app where step 7 set a controller, confirm it with `bin/rails runner -e development 'puts DevOnboarder.base_controller'`, which prints that controller's name.
 - `DevOnboarder.base_controller` exists only when the app is a Rails app and keystone_ui is in the bundle. Never set it without the `defined?(DevOnboarder::Engine)` guard.
 - The setup page is mounted at `/dev_onboarder` by the gem itself when the app runs in development or test, and never in production. Never add a route for it.
 - In a Rails app with keystone_ui, the gem reads the repo's `.env` into the environment in development, before the app's own initializers, and leaves any variable the shell already sets as it is. Tell the developer this when the app already loads `.env` another way.
 - In a Rails app with keystone_ui and a `Setupfile`, a server started in development or test prints one line when a requirement outside any feature is new, changed or not met. Nothing is added to the app for it.
-- To move to a newer release, change the `tag:` in the `Gemfile` line and run `bundle update dev_onboarder`.
+- To take a newer 0.x release, run `bundle update dev_onboarder`. To move past 0.x, change the version in the `Gemfile` line first.
 - Writing the `Setupfile`, and running or reading the gem's command, are out of scope. Hand those to the develop local.

data/the_local/interface.yml

@@ -1,7 +1,7 @@
 scope: repo setup — the Setupfile that declares what a repo needs, and the command a new developer runs to check and fix it
 
 install:
-  - 'gem "dev_onboarder", github: "DYB-Development/dev_onboarder", tag: "v0.9.0"'
+  - 'gem "dev_onboarder", "~> 0.9"'
   - DevOnboarder.base_controller
 
 develop:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dev_onboarder
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - tylercschneider