jenkins_pivotal_release_notes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2be5f50c4a61255eb8ca3d37330de8bb4fe760e3
+  data.tar.gz: b28c5f17223fab1b94322e698c76d7e10e75576d
+SHA512:
+  metadata.gz: 5e6dabcceb2d65e4d5b04dc6ef8748fbc714592595c1fbf5698b2510da9b3175b9d9ac7ad3c28884adeb7c4bd34e93ba25a76d21b7898ba2d7e4f82c26d5679f
+  data.tar.gz: e831e4d4ec79ce68be7e9e5502c381b82ce4e5f2f36c08bd873ee9702ea14dac0c11b496e419ba73c07c34d7f791676bf83d244bb1f7dfbcac840c01ef04db9f

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+*.swp
+.DS_Store
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gaurdfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jenkins_pivotal_release_notes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kenny Chapman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Jenkins + Pivotal Release Notes
+
+Generates release notes from Pivotal Tracker
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jenkins_pivotal_release_notes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jenkins_pivotal_release_notes
+
+## Usage
+
+In Jenkins, add a post build step like:
+
+```
+jenkins_pivotal --token a1b2c3 --project 1234 --date 05/01/2015 --file /Users/username/release_notes.txt
+```
+
+Help output is as follows.
+
+```
+Usage: bin/jenkins_pivotal_release_notes [options...]
+    -t, --token        Tracker API token.
+    -p, --project      Tracker Project ID.
+    -d, --date         Story fetch date
+    -f, --file         Saved file path
+    -v, --version      Display version information.
+    -h, --help         Display this help message.
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/jenkins_pivotal_release_notes/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/jenkins_pivotal_release_notes

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+root = File.expand_path '../../lib', __FILE__
+$:.unshift(root) unless $:.include?(root)
+
+require 'jenkins_pivotal_release_notes'
+
+JenkinsPivotalReleaseNotes::Cli.new(ARGV).run!

data/jenkins_pivotal_release_notes.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jenkins_pivotal_release_notes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jenkins_pivotal_release_notes"
+  spec.version       = JenkinsPivotalReleaseNotes::VERSION
+  spec.authors       = ["Kenny Chapman"]
+  spec.email         = ["lkchapman@gmail.com"]
+
+  spec.summary       = %q{Pivotal Tracker release notes -> Jenkins}
+  spec.description   = %q{Pivotal Tracker release notes -> Jenkins}
+  spec.homepage      = "https://github.com/chap19150/jenkins_pivotal_release_notes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "slop", "~> 3.4"
+  spec.add_dependency "tracker_api", "~> 0.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/jenkins_pivotal_release_notes.rb

@@ -0,0 +1,6 @@
+require "jenkins_pivotal_release_notes/version"
+require "jenkins_pivotal_release_notes/cli"
+require "jenkins_pivotal_release_notes/agent"
+
+module JenkinsPivotalReleaseNotes
+end

data/lib/jenkins_pivotal_release_notes/agent.rb

@@ -0,0 +1,110 @@
+require 'tracker_api'
+
+module JenkinsPivotalReleaseNotes
+  class Agent
+    attr_reader :token, :project, :date, :file
+
+    def initialize(options)
+      @token = options[:token]
+      @project = options[:project].to_i
+      @date = options[:date]
+      @file = options[:file]
+    end
+
+    def run!
+      puts date
+      puts file
+      output = ""
+      client = TrackerApi::Client.new(token: token)
+      currentProject  = client.project(project)
+      featureStories = currentProject.stories(filter: 'accepted_since:' + date  + ' type:Feature')
+      inProgressStories = currentProject.stories(filter: 'state:started state:finished state:delivered type:Feature')
+      bugStories = currentProject.stories(filter: '-state:delivered -state:accepted type:Bug')
+      output.concat(currentProject.name + " Release Notes\n\n")
+      if featureStories.size > 0
+        output.concat("NEWLY COMPLETED FEATURES\n")
+        output.concat("========================\n")
+        for story in featureStories
+          output.concat(story.name + "\n")
+        end
+      end
+
+      if inProgressStories.size > 0
+        output.concat("IN PROGRESS FEATURES\n")
+        output.concat("====================\n")
+        for story in inProgressStories
+          output.concat(story.name + "\n")
+        end
+        output.concat("\n")
+      end
+
+      if bugStories.size > 0
+        output.concat("KNOWN BUGS\n")
+        output.concat("==========\n")
+        for story in bugStories
+          output.concat(story.name + "\n")
+        end
+        output.concat("\n")
+      end
+
+      File.write(file, output)
+    end
+
+    def changelog_paths
+      # TODO this should be extracted into ChangelogGatherer or something
+      if ENV['CHANGELOG_PATH']
+        return [ ENV['CHANGELOG_PATH'] ]
+      end
+
+      start_from = 1
+      default_changelog = File.join env_variables['JENKINS_HOME'],
+        'jobs', env_variables['JOB_NAME'],
+        'builds', env_variables['BUILD_NUMBER'],
+        'changelog.xml'
+
+      # If it's the first build, there's nothing to gather.
+      if env_variables['BUILD_NUMBER'] == '1'
+        return [ default_changelog ]
+      end
+
+      last_success = File.join env_variables['JENKINS_HOME'],
+        'jobs', env_variables['JOB_NAME'],
+        'builds', 'lastSuccessfulBuild'
+
+      last_success_num = File.readlink last_success
+      if last_success_num != '-1'
+        # If the lastSuccessfulBuild was the previous build then the
+        # changelog will already be adequate.
+        if last_success_num.to_i == env_variables['BUILD_NUMBER'].to_i - 1
+          return [ default_changelog ]
+        else
+          start_from = last_success_num.to_i + 1
+        end
+      end
+
+      start_from.upto(env_variables['BUILD_NUMBER'].to_i).map do |i|
+        File.join env_variables['JENKINS_HOME'],
+          'jobs', env_variables['JOB_NAME'],
+          'builds', i.to_s,
+          'changelog.xml'
+      end
+    end
+
+    private
+
+    def env_variables
+      ENV
+    end
+
+    def changelog_path
+      if ENV['CHANGELOG_PATH']
+        return ENV['CHANGELOG_PATH']
+      end
+
+      File.join ENV['JENKINS_HOME'],
+        'jobs', ENV['JOB_NAME'],
+        'builds', ENV['BUILD_NUMBER'],
+        'changelog.xml'
+    end
+  end
+end

data/lib/jenkins_pivotal_release_notes/cli.rb

@@ -0,0 +1,36 @@
+require 'slop'
+
+module JenkinsPivotalReleaseNotes
+  class Cli
+    attr_reader :options
+
+    def initialize(items = ARGV)
+      @options = Slop.parse(items, help: true) do
+        banner "Usage: #{$0} [options...]"
+
+        on 't', 'token=', 'Tracker API token.'
+        on 'p', 'project=', 'Tracker Project ID.', as: :integer
+        on 'd', 'date=', 'Story fetch date'
+        on 'f', 'file=', 'Saved file path'
+        on 'v', 'version', 'Display version information.' do
+          puts "#{$0} #{JenkinsPivotal::VERSION}"
+          exit 0
+        end
+      end
+    end
+
+    def run!
+      unless options.token? && options.project?
+        puts @options
+        exit 1
+      end
+
+      Agent.new(
+        token: options[:token],
+        project: options[:project],
+        date: options[:date],
+        file: options[:file],
+      ).run!
+    end
+  end
+end

data/lib/jenkins_pivotal_release_notes/version.rb

@@ -0,0 +1,3 @@
+module JenkinsPivotalReleaseNotes
+  VERSION = "0.1.0"
+end

data/spec/jenkins_pivotal_release_notes_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe JenkinsPivotalReleaseNotes do
+  it 'has a version number' do
+    expect(JenkinsPivotalReleaseNotes::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'jenkins_pivotal_release_notes'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: jenkins_pivotal_release_notes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kenny Chapman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: tracker_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pivotal Tracker release notes -> Jenkins
+email:
+- lkchapman@gmail.com
+executables:
+- jenkins_pivotal_release_notes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gaurdfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/jenkins_pivotal_release_notes
+- jenkins_pivotal_release_notes.gemspec
+- lib/jenkins_pivotal_release_notes.rb
+- lib/jenkins_pivotal_release_notes/agent.rb
+- lib/jenkins_pivotal_release_notes/cli.rb
+- lib/jenkins_pivotal_release_notes/version.rb
+- spec/jenkins_pivotal_release_notes_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chap19150/jenkins_pivotal_release_notes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Pivotal Tracker release notes -> Jenkins
+test_files:
+- spec/jenkins_pivotal_release_notes_spec.rb
+- spec/spec_helper.rb