Merge pull request #118 from yukihirop/before_release_v0.2.0

Before release v0.2.0
yukihirop · May 2, 2020 · 9f4c2d8 · 9f4c2d8
2 parents 37ccddf + b38356a
commit 9f4c2d8
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,20 @@
 # Change Log
 
+## v0.2.0
+
+2020-05-02
+
+- [`Feature/Breaking`] Upgrade `routes:oas:docs` cmd ([37ccddf](https://github.com/yukihirop/r2-oas/pull/117))
+
+  - `.docs` is needed to continue using r2-oas. `If you are using previous version`,you need to run the following command to generate `.docs`.
+
+    ```bash
+    CACHE_DOCS=true bundle exec rake routes:oas:docs
+    ```
+
+- [`Breaking`] Divide into `Generator` and `Builder` ([00fea7d](https://github.com/yukihirop/r2-oas/pull/116))
+  - `routes:oas:docs` cmd do not generate `oas_docs/oas_doc.yml`
+
 ## v0.1.3
 
 2020-04-27

diff --git a/GEMSPEC.md b/GEMSPEC.md
@@ -0,0 +1,23 @@
+Let's intuitively write API documentation with Swagger Editor in your Rails Project! 😊
+
+Configureless and no DSL. 👍 But you can also configure.
+
+Loosely coupled to your Rails project. 👍
+
+So If it doesn't, you can always stop easily. 😢
+
+Generate api docment(OpenAPI) side only from `Rails` routing.
+
+Provide rake tasks to management API Docment (OpenAPI) 🎉
+
+
+    $ bundle exec rake routes:oas:docs    # generate
+    $ bundle exec rake routes:oas:ui      # view
+    $ bundle exec rake routes:oas:editor  # edit
+    $ bundle exec rake routes:oas:monitor # monitor
+    $ bundle exec rake routes:oas:dist    # distribute
+    $ bundle exec rake routes:oas:clean   # clean
+    $ bundle exec rake routes:oas:analyze # analyze
+    $ bundle exec rake routes:oas:deploy  # deploy
+
+Happy Coding ❗️
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    r2-oas (0.1.3)
+    r2-oas (0.2.0)
       docker-api (~> 1.34.2)
       easy_diff (~> 1.0.0)
       eventmachine (~> 1.2.0)

diff --git a/README.ja.md b/README.ja.md
@@ -55,12 +55,12 @@ bundle exec routes:oas:editor
 
 #### Generate docs
 
-![oas_docs](https://user-images.githubusercontent.com/11146767/80364449-e678db80-88c0-11ea-8920-d757717ec610.gif)
+![oas_docs](https://user-images.githubusercontent.com/11146767/80856236-0b839a80-8c83-11ea-888f-d0e659e0c251.gif)
 
 
 #### Edit docs
 
-![oas_editor](https://user-images.githubusercontent.com/11146767/80364657-4079a100-88c1-11ea-8f56-c9af78829d68.gif)
+![oas_editor](https://user-images.githubusercontent.com/11146767/80856240-15a59900-8c83-11ea-9dbd-4382528944f2.gif)
 
 ## 📚 Documents
 

diff --git a/README.md b/README.md
@@ -65,12 +65,12 @@ bundle exec routes:oas:editor
 
 #### Generate docs
 
-![oas_docs](https://user-images.githubusercontent.com/11146767/80364449-e678db80-88c0-11ea-8920-d757717ec610.gif)
+![oas_docs](https://user-images.githubusercontent.com/11146767/80856236-0b839a80-8c83-11ea-888f-d0e659e0c251.gif)
 
 
 #### Edit docs
 
-![oas_editor](https://user-images.githubusercontent.com/11146767/80364657-4079a100-88c1-11ea-8f56-c9af78829d68.gif)
+![oas_editor](https://user-images.githubusercontent.com/11146767/80856240-15a59900-8c83-11ea-9dbd-4382528944f2.gif)
 
 ## Usage
 

diff --git a/docs/README.md b/docs/README.md
@@ -65,12 +65,12 @@ bundle exec routes:oas:editor
 
 #### Generate docs
 
-![oas_docs](https://user-images.githubusercontent.com/11146767/80364449-e678db80-88c0-11ea-8920-d757717ec610.gif)
+![oas_docs](https://user-images.githubusercontent.com/11146767/80856236-0b839a80-8c83-11ea-888f-d0e659e0c251.gif)
 
 
 #### Edit docs
 
-![oas_editor](https://user-images.githubusercontent.com/11146767/80364657-4079a100-88c1-11ea-8f56-c9af78829d68.gif)
+![oas_editor](https://user-images.githubusercontent.com/11146767/80856240-15a59900-8c83-11ea-9dbd-4382528944f2.gif)
 
 ## 📖 Usage
 

diff --git a/lib/r2-oas/version.rb b/lib/r2-oas/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module R2OAS
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end
diff --git a/r2-oas.gemspec b/r2-oas.gemspec
@@ -11,10 +11,16 @@ Gem::Specification.new do |spec|
   spec.email         = ['[email protected]']
 
   spec.summary       = 'Provide rake tasks to management API Docment (OpenAPI)'
-  spec.description   = "Let's intuitively write API documentation with Swagger Editor in your Rails Project! 😊 Provide rake tasks to management API Docment (OpenAPI) 🎉"
+  spec.description   = %Q{#{IO.read('GEMSPEC.md')}}
 
-  spec.homepage      = 'https://yukihirop.github.io/r2-oas'
+  spec.homepage      = 'https://github.com/yukihirop/r2-oas'
   spec.license       = 'MIT'
+  spec.metadata = {
+    "bug_tracker_uri"   => "https://github.com/yukihirop/r2-oas/issues",
+    "changelog_uri"     => "https://github.com/yukihirop/r2-oas/blob/v#{spec.version}/CHANGELOG.md",
+    "documentation_uri" => "https://yukihirop.github.io/r2-oas",
+    "source_code_uri"   => "https://github.com/yukihirop/r2-oas/tree/v#{spec.version}"
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.