capistrano-sentry 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: ef57efce3e789c26a60d2824b696ea1aad0d2f2d7c8be1b06f398d0090fdca5d
4
+ data.tar.gz: a685ce5a4a9ae0e95c2fd49c4fa21cde424306061c6302a41dd125d9d5e82e98
5
+ SHA512:
6
+ metadata.gz: d738d4b7339370759d5837800a0ea0ea6ab37b9f8dde68a7e7a3270bbdcdf92bbb619ba7ec2566b3345803c7a7a80870d129f92c0ab020c9ce76ebce8b875de4
7
+ data.tar.gz: 6e266075e92eaef67c8111ebce83d3149df7c904e2aa0388212cdfd6d7670f6e9ca94e383ea32f101b7a408b567473ef78f64d514b7a6a0798ac0063c2ba9100
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ *~
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.5.1
7
+ before_install: gem install bundler -v 1.17.1
@@ -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 brice@codeur.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,6 @@
1
+ source 'https://rubygems.org'
2
+
3
+ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in capistrano-sentry.gemspec
6
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Brice Texier
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,56 @@
1
+ # Capistrano::Sentry
2
+
3
+ Simple extension of capistrano for automatic notification of Sentry.
4
+
5
+ TODO: Prevent user at deployment start if missing parameter to inform sentry
6
+ properly
7
+
8
+ ## Installation
9
+
10
+ Add this line to your application's Gemfile:
11
+
12
+ ```ruby
13
+ gem 'capistrano-sentry'
14
+ ```
15
+
16
+ Then, add this line to your application's Capfile:
17
+
18
+ ```ruby
19
+ require 'capistrano/sentry'
20
+ ```
21
+
22
+ And then execute:
23
+
24
+ $ bundle
25
+
26
+ ## Usage
27
+
28
+ Add these lines to your application's `config/deploy.rb`:
29
+
30
+ ```ruby
31
+ # Sentry deployment notification
32
+ set :sentry_api_token, 'd9fe44a1cf34e63993e258dbecf42158918d407978a1bb72f8fb5886aa5f9fe1'
33
+ set :sentry_organization, 'my-org' # fetch(:application) by default
34
+ set :sentry_project, 'my-proj' # fetch(:application) by default
35
+ set :sentry_repo, 'my-org/my-proj' # computed from repo_url by default
36
+
37
+ after 'deploy:published', 'sentry:notice_deployment'
38
+ ```
39
+
40
+ ## Development
41
+
42
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
43
+
44
+ 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).
45
+
46
+ ## Contributing
47
+
48
+ Bug reports and pull requests are welcome on GitHub at https://github.com/codeur/capistrano-sentry. 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.
49
+
50
+ ## License
51
+
52
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
53
+
54
+ ## Code of Conduct
55
+
56
+ Everyone interacting in the Capistrano::Sentry project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/codeur/capistrano-sentry/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rake/testtask'
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << 'test'
6
+ t.libs << 'lib'
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task default: :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'capistrano/sentry'
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,30 @@
1
+ lib = File.expand_path('lib', __dir__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require 'capistrano/sentry/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'capistrano-sentry'
7
+ spec.version = Capistrano::Sentry::VERSION
8
+ spec.authors = ['Brice Texier']
9
+ spec.email = ['brice@codeur.com']
10
+
11
+ spec.summary = 'Sentry release/deployment integration'
12
+ spec.homepage = 'https://github.com/codeur/capistrano-sentry'
13
+ spec.license = 'MIT'
14
+
15
+ # Specify which files should be added to the gem when it is released.
16
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
17
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
18
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
19
+ end
20
+ spec.test_files = Dir.chdir(File.expand_path(__dir__)) do
21
+ `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(test|spec|features)/}) }
22
+ end
23
+ spec.require_paths = ['lib']
24
+
25
+ spec.add_dependency 'capistrano', '~> 3.1'
26
+
27
+ spec.add_development_dependency 'bundler', '~> 1.17'
28
+ spec.add_development_dependency 'minitest', '~> 5.0'
29
+ spec.add_development_dependency 'rake', '~> 10.0'
30
+ end
File without changes
@@ -0,0 +1 @@
1
+ load File.expand_path('tasks/sentry.rake', __dir__)
@@ -0,0 +1,5 @@
1
+ module Capistrano
2
+ module Sentry
3
+ VERSION = '0.1.2'.freeze
4
+ end
5
+ end
@@ -0,0 +1,71 @@
1
+ # This task will notify Sentry via their API[1] that you have deployed
2
+ # a new release. It uses the release timestamp as the `version`
3
+ # (like 20151113182847) and the git ref as the optional `ref` value.
4
+ #
5
+ # This task requires several environment variables be set (or just
6
+ # hardcode the values in here if you like living on the edge):
7
+ #
8
+ # ENV['SENTRY_API_ENDPOINT'] : API endpoint, https://app.getsentry.com
9
+ # ENV['SENTRY_ORG'] : the organization for this app
10
+ # ENV['SENTRY_PROJECT'] : the project for this app
11
+ # ENV['SENTRY_AUTH_TOKEN'] : a valid Auth token (replaces API Key)
12
+ #
13
+ # [1]: https://docs.getsentry.com/hosted/api/releases/post-project-releases
14
+
15
+ # For Rails app, this goes in config/deploy.rb
16
+
17
+ namespace :sentry do
18
+ desc 'Notice new deployment in Sentry (sentry.io)'
19
+ task :notice_deployment do
20
+ run_locally do
21
+ require 'uri'
22
+ require 'net/https'
23
+ require 'json'
24
+
25
+ uri = URI.parse('https://sentry.io')
26
+ http = Net::HTTP.new(uri.host, uri.port)
27
+ http.use_ssl = true
28
+
29
+ version = `git rev-parse --short=7 HEAD`.strip
30
+
31
+ orga_slug = fetch(:sentry_organization) || fetch(:application)
32
+ project = fetch(:sentry_project) || fetch(:application)
33
+ environment = fetch(:stage) || 'default'
34
+ api_token = ENV['SENTRY_API_TOKEN'] || fetch(:sentry_api_token)
35
+ repo_name = fetch(:sentry_repo) || fetch(:repo_url).split(':').last.gsub(/\.git$/, '')
36
+
37
+ headers = {
38
+ 'Content-Type' => 'application/json',
39
+ 'Authorization' => 'Bearer ' + api_token.to_s
40
+ }
41
+
42
+ req = Net::HTTP::Post.new("/api/0/organizations/#{orga_slug}/releases/", headers)
43
+ req.body = JSON.generate(
44
+ version: version,
45
+ refs: [{
46
+ repository: repo_name,
47
+ commit: fetch(:current_revision) || `git rev-parse HEAD`.strip,
48
+ # previousCommit: fetch(:previous_revision)
49
+ }],
50
+ projects: [project]
51
+ )
52
+ response = http.request(req)
53
+ if response.is_a? Net::HTTPSuccess
54
+ req = Net::HTTP::Post.new("/api/0/organizations/#{orga_slug}/releases/#{version}/deploys/", headers)
55
+ req.body = JSON.generate(
56
+ environment: environment,
57
+ name: "#{project}-#{fetch(:environment)}-#{version}-#{fetch(:release_timestamp)}"
58
+ )
59
+ response = http.request(req)
60
+ puts "Cannot notify sentry for new deployment. Response: #{response.code.inspect}: #{response.body}" unless response.is_a? Net::HTTPSuccess
61
+ else
62
+ puts "Cannot notify sentry for new release. Response: #{response.code.inspect}: #{response.body}"
63
+ end
64
+ end
65
+ end
66
+ end
67
+
68
+ # If you want deployments to be published in every Rails environment, put this
69
+ # in config/deploy.rb, otherwise put it your environment-specific deploy file
70
+ # i.e. config/deploy/production.rb
71
+ # after 'deploy:published', 'sentry:notice_deployment'
@@ -0,0 +1,11 @@
1
+ require 'test_helper'
2
+
3
+ class Capistrano::SentryTest < Minitest::Test
4
+ def test_that_it_has_a_version_number
5
+ refute_nil ::Capistrano::Sentry::VERSION
6
+ end
7
+
8
+ def test_it_does_something_useful
9
+ assert false
10
+ end
11
+ end
@@ -0,0 +1,4 @@
1
+ $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
2
+ require 'capistrano/sentry'
3
+
4
+ require 'minitest/autorun'
metadata ADDED
@@ -0,0 +1,118 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: capistrano-sentry
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.2
5
+ platform: ruby
6
+ authors:
7
+ - Brice Texier
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2018-11-27 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: capistrano
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '3.1'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.17'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.17'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ description:
70
+ email:
71
+ - brice@codeur.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".travis.yml"
78
+ - CODE_OF_CONDUCT.md
79
+ - Gemfile
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - bin/console
84
+ - bin/setup
85
+ - capistrano-sentry.gemspec
86
+ - lib/capistrano-sentry.rb
87
+ - lib/capistrano/sentry.rb
88
+ - lib/capistrano/sentry/version.rb
89
+ - lib/capistrano/tasks/sentry.rake
90
+ - test/capistrano/sentry_test.rb
91
+ - test/test_helper.rb
92
+ homepage: https://github.com/codeur/capistrano-sentry
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: '0'
110
+ requirements: []
111
+ rubyforge_project:
112
+ rubygems_version: 2.7.6
113
+ signing_key:
114
+ specification_version: 4
115
+ summary: Sentry release/deployment integration
116
+ test_files:
117
+ - test/capistrano/sentry_test.rb
118
+ - test/test_helper.rb