github-rake-release 0.1.1.pre.alpha

Sign up to get free protection for your applications and to get access to all the features.
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.4.0
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at rogerio.alcantara@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Rogério Rodrigues de Alcântara
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,105 @@
1
+ # Github::Rake::Release
2
+
3
+ Rake Tasks for Automating Github Releases
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'github-rake-release'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install github-rake-release
20
+
21
+ ## Usage
22
+
23
+ #### 1. Rakefile:
24
+
25
+ ```ruby
26
+ require 'github/rake/release'
27
+ ```
28
+
29
+ And list all available tasks:
30
+
31
+ $ bundle exec rake -T
32
+
33
+ #### 2. Configuration
34
+
35
+ The gem try to find out the repository name and assume that the branch to be merged to master is **develop**.
36
+
37
+ We can customise these values, tho:
38
+
39
+ ```ruby
40
+ # Rakefile
41
+
42
+ require 'github/rake/release'
43
+ Github::Rake::Release.configure do |config|
44
+ config.respository = 'username/repository-name'
45
+ config.merge_from = :development
46
+ end
47
+ ```
48
+
49
+ #### 3. Github authentication:
50
+
51
+ Create a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) selecting the scope **repo** on Github.
52
+
53
+ Then, export it as:
54
+
55
+ $ export GITHUB_ACCESS_TOKEN=your_github_token
56
+
57
+ And, then, authenticate on Github running:
58
+
59
+ $ bundle exec rake github:auth
60
+
61
+ #### 4. Merges the develop<sup name="branch-name-customisation">[1](#branch-name-customisation-reference)</sup> branch into master:
62
+
63
+ Running:
64
+
65
+ $ bundle exec rake github:merge
66
+
67
+ Will simply run:
68
+
69
+ $ git fetch
70
+ $ git checkout master
71
+ $ git pull
72
+ $ git merge origin/develop
73
+ $ git push
74
+
75
+ > <a name="branch-name-customisation-reference">[1]</a> see configuration to customise the branch name. [↩](#branch-name-customisation)
76
+
77
+ #### 5. Release
78
+
79
+ Running:
80
+
81
+ $ bundle exec rake github:release['v0.1.0', 'Release title', 'Release description']
82
+
83
+ Will run the merge task and create a release tag after merging using the provided parameters. 🚀
84
+
85
+ #### 6. Debugging
86
+
87
+ Running:
88
+
89
+ $ bundle exec rake github:repo
90
+
91
+ Shows the repository where the release will be created
92
+
93
+ ## Development
94
+
95
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
96
+
97
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
98
+
99
+ ## Contributing
100
+
101
+ Bug reports and pull requests are welcome on GitHub at https://github.com/roalcantara/github-rake-release. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
102
+
103
+ ## License
104
+
105
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+ RSpec::Core::RakeTask.new(:spec)
4
+ task default: :spec
5
+
6
+ require 'github/rake/release'
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'github/rake/release'
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require 'irb'
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,29 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'github/rake/release/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'github-rake-release'
8
+ spec.version = Github::Rake::Release::VERSION
9
+ spec.authors = ['Rogério Rodrigues de Alcântara']
10
+ spec.email = ['rogerio.alcantara@gmail.com']
11
+
12
+ spec.summary = 'Github Release Rake Tasks'
13
+ spec.description = 'Rake Tasks for Automating Github Releases'
14
+ spec.homepage = 'https://github.com/roalcantara/github-rake-release'
15
+ spec.license = 'MIT'
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = 'exe'
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ['lib']
23
+
24
+ spec.add_development_dependency 'bundler', '~> 1.14'
25
+ spec.add_development_dependency 'rspec', '~> 3.0'
26
+
27
+ spec.add_dependency 'rake', '~> 10.0'
28
+ spec.add_dependency 'octokit', '~> 4.7'
29
+ end
@@ -0,0 +1,27 @@
1
+ require 'github/rake/release/version'
2
+ require 'github/rake/release/config'
3
+ require 'github/rake/release/tasks'
4
+
5
+ module Github
6
+ module Rake
7
+ module Release
8
+ class << self
9
+ attr_accessor :config
10
+ end
11
+
12
+ def self.config
13
+ @config ||= Config.new
14
+ end
15
+
16
+ def self.configure
17
+ yield(config)
18
+ end
19
+
20
+ def self.reset!
21
+ @config = Config.new
22
+ end
23
+ end
24
+ end
25
+ end
26
+
27
+ Github::Rake::Release::Tasks.new
@@ -0,0 +1,14 @@
1
+ module Github
2
+ module Rake
3
+ module Release
4
+ class Config
5
+ attr_accessor :respository, :merge_from
6
+
7
+ def initialize
8
+ @respository = `git remote get-url origin`.gsub!('https://github.com/', '').gsub!('.git', '').strip
9
+ @merge_from = :develop
10
+ end
11
+ end
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,83 @@
1
+ require 'octokit'
2
+ require 'rake/tasklib'
3
+
4
+ module Github
5
+ module Rake
6
+ module Release
7
+ class Tasks < ::Rake::TaskLib
8
+ def initialize
9
+ define_github_auth_task
10
+ define_github_merge_task
11
+ define_github_release_task
12
+ define_github_repository_task
13
+ end
14
+
15
+ private
16
+
17
+ def define_github_auth_task
18
+ namespace :github do
19
+ desc 'GitHub authentication'
20
+ task :auth do
21
+ begin
22
+ Octokit.configure do |c|
23
+ c.access_token = ENV['GITHUB_ACCESS_TOKEN']
24
+ end
25
+
26
+ rate_limit = Octokit.rate_limit!
27
+ puts 'Exceeded limit of the GitHub API request' if rate_limit.remaining.zero?
28
+ puts 'Github Authentication: OK! 🤘'
29
+ rescue => e
30
+ puts e.message
31
+ end
32
+ end
33
+ end
34
+ end
35
+
36
+ def define_github_merge_task
37
+ namespace :github do
38
+ desc 'Merges the develop branch into master'
39
+ task :merge do
40
+ sh 'git fetch'
41
+ sh 'git checkout master'
42
+ sh 'git pull'
43
+ sh "git merge origin/#{Github::Rake::Release.config.merge_from}"
44
+ sh 'git push'
45
+ end
46
+ end
47
+ end
48
+
49
+ def define_github_release_task
50
+ namespace :github do
51
+ desc 'Merges the develop branch into master and creates a release tag on github'
52
+ task :release, [:version, :title, :body] => ['github:auth', :merge] do |_, args|
53
+ begin
54
+ puts "Creating `#{args.version}` release tag at `#{Github::Rake::Release.config.respository}`.."
55
+ Octokit.create_release(
56
+ Github::Rake::Release.config.respository,
57
+ args.version,
58
+ name: args.title,
59
+ body: args.body,
60
+ target_commitish: :master,
61
+ draft: false,
62
+ prerelease: false
63
+ )
64
+ puts "#{args.version} has been released in the wild! 🚀"
65
+ rescue => e
66
+ puts e.message
67
+ end
68
+ end
69
+ end
70
+ end
71
+
72
+ def define_github_repository_task
73
+ namespace :github do
74
+ desc 'Shows the github repository where the release will be created'
75
+ task :repo do
76
+ puts Github::Rake::Release.config.respository
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,7 @@
1
+ module Github
2
+ module Rake
3
+ module Release
4
+ VERSION = '0.1.1-alpha'.freeze
5
+ end
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: github-rake-release
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1.pre.alpha
5
+ platform: ruby
6
+ authors:
7
+ - Rogério Rodrigues de Alcântara
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-04-09 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.14'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.14'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rspec
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '3.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '3.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: octokit
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '4.7'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '4.7'
69
+ description: Rake Tasks for Automating Github Releases
70
+ email:
71
+ - rogerio.alcantara@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".rubocop.yml"
79
+ - ".ruby-version"
80
+ - CODE_OF_CONDUCT.md
81
+ - Gemfile
82
+ - LICENSE.txt
83
+ - README.md
84
+ - Rakefile
85
+ - bin/console
86
+ - bin/setup
87
+ - github-rake-release.gemspec
88
+ - lib/github/rake/release.rb
89
+ - lib/github/rake/release/config.rb
90
+ - lib/github/rake/release/tasks.rb
91
+ - lib/github/rake/release/version.rb
92
+ homepage: https://github.com/roalcantara/github-rake-release
93
+ licenses:
94
+ - MIT
95
+ metadata: {}
96
+ post_install_message:
97
+ rdoc_options: []
98
+ require_paths:
99
+ - lib
100
+ required_ruby_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ required_rubygems_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">"
108
+ - !ruby/object:Gem::Version
109
+ version: 1.3.1
110
+ requirements: []
111
+ rubyforge_project:
112
+ rubygems_version: 2.6.11
113
+ signing_key:
114
+ specification_version: 4
115
+ summary: Github Release Rake Tasks
116
+ test_files: []