platform-api 3.7.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4df90c15a3a7108112d47c4a8912f2c0cc0c133f220f9b7b18a90f5f81b8eb84
-  data.tar.gz: 6466930cc95ffab375021eb6a3442aaf320d72cfaec9f2f8b78548c9798ffbaf
+  metadata.gz: 52250589350e16aa52fe43d0540f27128e092885cfb546738a094c970809ca02
+  data.tar.gz: 801a2ce042978af42acd27e4eb9876dda2bac633bbfc0fd4512ce07af5cc798f
 SHA512:
-  metadata.gz: 63e2ae18a43482dc82198b1b189048820530d0ec59d17b4a9f8836b7cfe5e9e448b772bfc7f063455abc2b15c7c05a67feb8eae72bfa57dc0bb31c54e2af2d57
-  data.tar.gz: 7787d7c3d99164a0d6737250f66b29e0fb1a755292a67c5e62da8c84452ab7bcfac1380318bc1e5ed3b4cd54c7e7bd83484134eb1accf9c6014c17b7144eb995
+  metadata.gz: 60b3f38af31cf1231b84a01dd0fdb5cc4499f5c54ce9c0c9d174f605fc888db6b29c2b3deecb5fd864ad23134a9482753058a46ec958459d15beb379e1dbe807
+  data.tar.gz: 025f9f9f5bc3f55a2bb09052ca81a8dee8fbfb4ba5a55fc71bd96a143981cbef9cc26128eb15613883abbf7064940a5448081de9d222966e609c0da23203500c

data/.github/workflows/rspec.yml

@@ -0,0 +1,31 @@
+name: CI tests
+on:
+  push:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '3.2', '3.3', '3.4', '4.0' ]
+    env:
+      HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
+      HEROKU_API_USER: ${{ secrets.HEROKU_API_USER }}
+
+    name: Setup env & run tests with Ruby ${{ matrix.ruby }}
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: "Set bundler path"
+        run: bundle config set path 'vendor/bundle'
+      - name: "Install dependencies"
+        run: bundle install --jobs=4 --retry=3
+      - name: "Hatchet setup"
+        run: bundle exec hatchet ci:setup
+      - name: "Run tests"
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -1,6 +1,14 @@
-## Master (unreleased)
+## Main (unreleased)
 
-## 3.6.0
+## 3.9.0
+
+- Pull latest JSON Schema and regenerated API.
+
+## 3.8.0
+
+- Pull latest JSON Schema and regenerated API.
+
+## 3.7.0
 
 - Pull latest JSON Schema and regenerated API.
 

data/README.md

@@ -26,7 +26,7 @@ gem install platform-api
 
 ## API documentation
 
-Jump right to the [API documentation](http://heroku.github.io/platform-api/_index.html)
+Jump right to the [API documentation](https://www.rubydoc.info/gems/platform-api)
 for the nitty gritty details.
 
 ## Usage guide
@@ -51,7 +51,7 @@ For example, to get information about the `web` formation on the `sushi` app
 you'd invoke `heroku.formation.info('sushi', 'web')` and it would return a
 Ruby object that matches the one given in the [response example](https://devcenter.heroku.com/articles/platform-api-reference#formation-info).
 
-The [API documentation](http://heroku.github.io/platform-api/_index.html) contains a
+The [API documentation](https://www.rubydoc.info/gems/platform-api) contains a
 description of all available resources and methods.
 
 ### Handling errors
@@ -217,7 +217,7 @@ $ heroku labs:enable websockets
 $ heroku addons:add openredis:micro # $10/month
 Adding openredis:micro on floating-retreat-4255... done, v10 ($10/mo)
 Use `heroku addons:docs openredis` to view documentation.
-$ git push heroku master
+$ git push heroku main
 Initializing repository, done.
 Counting objects: 489, done.
 Delta compression using up to 4 threads.
@@ -370,23 +370,6 @@ Remember to commit and push the changes to Github.
 * `git commit -m 'vX.Y.Z' to stage the version and Gemfile.lock changes
 * `rake release` to push git changes and to release to Rubygems
 
-### Building API documentation
-
-Build documentation with:
-
-```
-rake yard
-```
-
-And then visit `doc/index.html` to read it. Alternately, build and publish
-it to Github Pages in one step with:
-
-```
-rake publish_docs
-```
-
-You can see it live on [Github Pages](http://heroku.github.io/platform-api/).
-
 ## Contributing
 
 1. [Fork the repository](https://github.com/heroku/platform-api/fork).
@@ -404,7 +387,7 @@ $ git clone https://github.com/heroku/ruby-getting-started.git
 $ cd ruby-getting-started/
 $ heroku create <memorable-name-here>
 $ heroku webhooks:add -i api:dyno -l notify -u https://example.com/hooks
-$ git push heroku master
+$ git push heroku main
 ```
 
 Now you can specify your app name while you run tests:

data/Rakefile

@@ -21,7 +21,7 @@ task :publish_docs => [:build] do
   sh 'git add -A .'
   sh 'git commit -am "Rebuild documentation"'
   sh 'git push origin gh-pages'
-  sh 'git checkout master'
+  sh 'git checkout main'
 end
 
 # After releasing publish the docs