pr_releasenotes 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78e490c7b05492ae9c389da01992071a95f386cd79e58775ca150207ed343217
-  data.tar.gz: 4d076be623487de18e41bd0d65267333c2925d18f5f70d4b256f14c14ab6bb8f
+  metadata.gz: 1f55def65ebcb8da0550bab03c5c6d6b0ad775c09cb4fd44ffa4f1d3ef8eaeaa
+  data.tar.gz: 1ce9f1cb3378aadf6b96446055b6d64bd2883c32c7ff54b73c7a4f9b545954f2
 SHA512:
-  metadata.gz: 02ada146643812fc9c0bb24610ab7b093c7c70560451a2922bce31fb4861bbcffbacdb922fc9edcb4866e71857a3a2dc195a769871bc044dc5446a1289d4df3a
-  data.tar.gz: 85a5b2df377cc5974d2a834110da4bca1bf62c18aad92077825cc4994b111c44d8cab34eddf4f4f3c9d1f9d5b75026b2dff54834465bf36c1f8a11c7b3c690cf
+  metadata.gz: 3f1c0a5e019d7b05f60966ca24daaf822e7b478518fde15e90f9c4ab242629cf036388736080bc4498b18a79930d01fd5e109bf4279479c1c54027e78081b159
+  data.tar.gz: 0b944ab1b34325b86602933ce841f0c032ba252bc816bd957c514e9e46b85e04afa81eba24917292a054f812f41df553336ffd6611c624f6a78435e6f436beb2

data/README.md

@@ -12,7 +12,7 @@ will generate release notes from your latest release tag to the tip of the maste
 
 There are quite a few online tools for generating release notes based on github history, but all the ones I've found rely on commit messages. This makes them inflexible, since it would require rewriting commit history in order to make any changes to the generated notes. In addition, using commit messages forces irrelevant information such as `fixed typo`, `reverted incorrect commit`, and `updated tests/docs` into the release notes.
 
-This tool uses pull request descriptions, so the release notes for any version can be updated at any time by simply updating the corresponding pull request's description and rerunning this tool. In addition, pull request descriptions can have a separate brief and focused section to expose only the necessary information into the release notes. 
+This tool uses pull request descriptions, so the release notes for any version can be updated at any time by simply updating the corresponding pull request's description and rerunning this tool. In addition, pull request descriptions can have a separate brief and focused section to expose only the necessary information into the release notes.
 
 Finally, this tool provides the additional option to post the release notes back to the github releases page.
 
@@ -72,15 +72,17 @@ This tool can be invoked right after a release build to automatically add releas
 For regular releases where a previous release already exists, and a new release is being created, this tool can be invoked after the release is built by using the following form:
 
     $ pr_releasenotes --repo <user/repo> --token <token> --end <current_release_tag>
-    
+
 The tool will set the start_tag to the latest tagged release prior to the current one and generate release notes from that release to the current one.
 
+By default, a release will be prerelease. Use `--full-release` to create a full release to the repo.
+
 #### Initial release
 
 For the initial release from a repo, there is no previous release, so the tool must be run with an explicit start sha or tag:
 
     $ pr_releasenotes --repo <user/repo> --token <token> --start <commit_sha> --end <current_release_tag>
- 
+
 Both the `--start` and `--end` parameters support sha values as well as tags, so release notes can be generated between any two tags or commits.
 
 

data/lib/pr_releasenotes.rb

@@ -241,16 +241,16 @@ module PrReleasenotes
           # Found existing release, so update it
           log.info "Found existing #{release.draft? ? 'draft ' : ''}#{release.prerelease? ? 'pre-' : ''}release with tag #{tag_name} at #{release.html_url}#{release.body.nil? || release.body.empty? ? '' : " with body: #{release.body}"}"
           begin
-            release = git_client.update_release(release.url, { :name => tag_name, :body => notes_str, :draft => false, :prerelease => true })
-            log.info "Updated pre-release #{release.id} at #{release.html_url} with body\n\n #{notes_str}"
+            release = git_client.update_release(release.url, { :name => tag_name, :body => notes_str, :draft => false, :prerelease => config.prerelease })
+            log.info "Updated #{config.prerelease ? "prerelease" : "full release"} #{release.id} at #{release.html_url} with body\n\n #{notes_str}"
           rescue Octokit::NotFound
             raise "Unable to post release to github. Ensure your token has the right permissions."
           end
         rescue Octokit::NotFound
           # no existing release, so try create a new one for this end_tag
           begin
-            release = git_client.create_release(config.repo, tag_name, { :name => tag_name, :body => notes_str, :draft => false, :prerelease => true })
-            log.info "Created pre-release #{release.id} at #{release.html_url} with body\n\n #{notes_str}"
+            release = git_client.create_release(config.repo, tag_name, { :name => tag_name, :body => notes_str, :draft => false, :prerelease => config.prerelease })
+            log.info "Created #{config.prerelease ? "prerelease" : "full release"} #{release.id} at #{release.html_url} with body\n\n #{notes_str}"
           rescue Octokit::NotFound
             raise "Unable to post release to github. Ensure your token has the right permissions."
           end

data/lib/pr_releasenotes/configuration.rb

@@ -22,7 +22,7 @@ module PrReleasenotes
     require "pr_releasenotes/version"
 
     attr_accessor :repo, :token, :tag_prefix, :min_sha_size, :start_tag, :end_tag,
-                  :branch, :include_all_prs, :github_release, :relnotes_group,
+                  :branch, :include_all_prs, :github_release, :prerelease, :relnotes_group,
                   :categorize, :category_prefix, :category_default, :relnotes_hdr_prefix,
                   :jira_baseurl, :auto_paginate, :log
 
@@ -48,6 +48,8 @@ module PrReleasenotes
       @include_all_prs = true
       # Finish by posting release notes to github
       @github_release = false
+      # Release notes are defaulted to be prerelease
+      @prerelease = true
 
       # Release notes parsing options. Note that comments will always get stripped
       # By default, only the PR titles will be used, so match nothing from the description
@@ -125,6 +127,9 @@ module PrReleasenotes
         opts.on('-p', '--post-to-github', 'Create/update release on github') do
           @github_release = true
         end
+        opts.on('-f', '--full-release', 'Create a full release') do
+          @prerelease = false
+        end
 
         opts.separator ''
         opts.on('-d', '--debug', 'Enable debug logging') do

data/lib/pr_releasenotes/version.rb

@@ -1,3 +1,3 @@
 module PrReleasenotes
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr_releasenotes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - arvindth
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2019-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Post pull request based release notes to github releases