pig-ci-rails 0.2.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 45e75a450ac91998d1c684580aadb2f2beab4dc4b12aefc2b1cc39ff18d6aced
4
- data.tar.gz: 35ceebb576bae40eaeb17566ae3cfa764e165c68e4c2680f4257b1046849d79d
3
+ metadata.gz: bae1ce03e29550315c467e865b65536f7e3038567a86492b027e846eb43d1839
4
+ data.tar.gz: 8d3f2ef7753ca0495da2a865141fd986059b56a7d7d9df29e46669c6bb8455fc
5
5
  SHA512:
6
- metadata.gz: d59558555c2138ea84554770b9e296c5e49d7f3c9b50f2913bf7d5a3b64be795e947440cf297665e9e726bae9ad5ab1934fec67f8194ed95692c8555d99b0b4b
7
- data.tar.gz: 74e3514d08d9021ab082f4e75c3edc8bf7e7c369b10a83583f96ec701e1f312325e1bf338286a168793eb06eb24de0aa54dac6540932fadc83ba26d8ba05d11c
6
+ metadata.gz: 59292f4d7e66a68f029c33268b6a7b7628b392018950013d690ce1e5851905eede905cf294e9f98fc3b54ad4a7f0bf3a415eb3b5cc7c626fc91c8a76a8b98ffa
7
+ data.tar.gz: 560812e1afc2c67ef9769b9a149ff5bd321f6128a6fbee1afa31ad954457af440392e1cdd04d3aac8e282d0bbf892d41ba4a1f4cf4f909c005feb3a23ff8d20d
@@ -0,0 +1,42 @@
1
+ # From: https://github.com/hopsoft/stimulus_reflex/blob/master/.github/workflows/changelog.yml
2
+ name: Changelog
3
+
4
+ on:
5
+ workflow_dispatch:
6
+ release:
7
+ types: [created]
8
+ push:
9
+ branches:
10
+ - master
11
+
12
+ jobs:
13
+ build:
14
+ runs-on: ubuntu-latest
15
+ timeout-minutes: 4
16
+ if: "!contains(github.event.head_commit.message, '[nodoc]')"
17
+ steps:
18
+ - uses: actions/checkout@master
19
+ - name: Set up Ruby 3.0
20
+ uses: ruby/setup-ruby@v1
21
+ with:
22
+ ruby-version: 3.0
23
+ - uses: actions/cache@v2
24
+ with:
25
+ path: vendor/bundle
26
+ key: ${{ runner.os }}-changelog-gem-${{ hashFiles('**/Gemfile.lock') }}
27
+ restore-keys: |
28
+ ${{ runner.os }}-changelog-gem-
29
+ - name: Create local changes
30
+ run: |
31
+ gem install github_changelog_generator -v "1.15.2"
32
+ github_changelog_generator -u ${{ github.repository_owner }} -p ${{ github.event.repository.name }} --token ${{ secrets.GITHUB_TOKEN }} --exclude-labels duplicate,question,invalid,wontfix,nodoc
33
+ - name: Commit files
34
+ run: |
35
+ git config --local user.email "github-actions@example.com"
36
+ git config --local user.name "GitHub Actions"
37
+ git commit -am "[nodoc] Update Changelog" || echo "No changes to commit"
38
+ - name: Push changes
39
+ uses: ad-m/github-push-action@master
40
+ with:
41
+ github_token: ${{ secrets.GITHUB_TOKEN }}
42
+ branch: ${{ github.ref }}
@@ -1,8 +1,8 @@
1
1
  name: Build & Publish Ruby Gem
2
2
 
3
3
  on:
4
- create:
5
- tags:
4
+ release:
5
+ types: [created]
6
6
 
7
7
  jobs:
8
8
  build:
@@ -11,19 +11,8 @@ jobs:
11
11
 
12
12
  steps:
13
13
  - uses: actions/checkout@v2
14
- - name: Set up Ruby 2.6
15
- uses: actions/setup-ruby@v1
14
+ - name: Publish to GitHub Packages
15
+ uses: jstastny/publish-gem-to-github@master
16
16
  with:
17
- version: 2.6.x
18
-
19
- - name: Publish to GPR
20
- run: |
21
- mkdir -p $HOME/.gem
22
- touch $HOME/.gem/credentials
23
- chmod 0600 $HOME/.gem/credentials
24
- printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
25
- gem build *.gemspec
26
- gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
27
- env:
28
- GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
29
- OWNER: MikeRogers0
17
+ token: ${{ secrets.GITHUB_TOKEN }}
18
+ owner: MikeRogers0
@@ -0,0 +1,27 @@
1
+ ---
2
+ name: Testing
3
+
4
+ on:
5
+ push:
6
+ pull_request:
7
+
8
+ jobs:
9
+ test:
10
+ strategy:
11
+ fail-fast: false
12
+ matrix:
13
+ ruby: [2.5, 2.6, 2.7]
14
+ runs-on: ubuntu-latest
15
+ name: Test against Ruby ${{ matrix.ruby }}
16
+
17
+ steps:
18
+ - uses: actions/checkout@v2
19
+ - uses: ruby/setup-ruby@v1
20
+ with:
21
+ ruby-version: ${{ matrix.ruby }}
22
+ bundler-cache: true
23
+ - name: Run tests
24
+ env:
25
+ RAILS_ENV: test
26
+ run: |
27
+ bundle exec rake spec
@@ -0,0 +1,27 @@
1
+ name: Standard
2
+
3
+ on:
4
+ push:
5
+ branches-ignore:
6
+ - master
7
+ jobs:
8
+ standard:
9
+ runs-on: ubuntu-latest
10
+
11
+ steps:
12
+ - uses: actions/checkout@v2
13
+ - name: Set up Ruby 2.7
14
+ uses: ruby/setup-ruby@v1
15
+ with:
16
+ ruby-version: 2.7
17
+ - name: Cache gems
18
+ uses: actions/cache@v2
19
+ with:
20
+ path: vendor/bundle
21
+ key: ${{ runner.os }}-standardrb
22
+ - name: Install gems
23
+ run: |
24
+ bundle config path vendor/bundle
25
+ gem install standardrb
26
+ - name: Run Standard
27
+ run: standardrb
data/CHANGELOG.md CHANGED
@@ -1,43 +1,155 @@
1
1
  # Changelog
2
2
 
3
- ## 0.3.0 (In Development)
3
+ ## [Unreleased](https://github.com/PigCI/pig-ci-rails/tree/HEAD)
4
4
 
5
- * TODO: Deprecate pigci.com integration.
5
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v1.0.1...HEAD)
6
6
 
7
- ## 0.2.0
7
+ **Fixed bugs:**
8
8
 
9
- * [Updating TravisCI to test latest ruby versions](https://github.com/PigCI/pig-ci-rails/pull/15)
10
- * [Update rake requirement from ~> 12.3 to ~> 13.0](https://github.com/PigCI/pig-ci-rails/pull/14)
11
- * [Update rspec requirement from ~> 3.8.0 to ~> 3.9.0](https://github.com/PigCI/pig-ci-rails/pull/16)
12
- * [Update webmock requirement from ~> 3.7.0 to ~> 3.8.0](https://github.com/PigCI/pig-ci-rails/pull/17)
13
- * [Adding config.thresholds, this allows standalone usage without pigci.com](https://github.com/PigCI/pig-ci-rails/pull/18) & [Replace references for limit to be threshold](https://github.com/PigCI/pig-ci-rails/pull/21)
14
- * Setting up repo to publish gem when new tags are created.
9
+ - Only eager loading app in Rails \>5.0 [\#38](https://github.com/PigCI/pig-ci-rails/pull/38) ([MikeRogers0](https://github.com/MikeRogers0))
15
10
 
16
- ## 0.1.5
11
+ **Merged pull requests:**
17
12
 
18
- * [Widen i18n gem version requirement](https://github.com/PigCI/pig-ci-rails/pull/12)
13
+ - Adding End Of Life notice [\#68](https://github.com/PigCI/pig-ci-rails/pull/68) ([MikeRogers0](https://github.com/MikeRogers0))
14
+ - Updating .github/workflows to be simpler [\#67](https://github.com/PigCI/pig-ci-rails/pull/67) ([MikeRogers0](https://github.com/MikeRogers0))
15
+ - Using pigci.mikerogers.io over pigci.com [\#66](https://github.com/PigCI/pig-ci-rails/pull/66) ([MikeRogers0](https://github.com/MikeRogers0))
16
+ - Updating changelog generator to push to master [\#60](https://github.com/PigCI/pig-ci-rails/pull/60) ([MikeRogers0](https://github.com/MikeRogers0))
17
+ - Update webmock requirement from ~\> 3.9.3 to ~\> 3.11.0 [\#59](https://github.com/PigCI/pig-ci-rails/pull/59) ([dependabot[bot]](https://github.com/apps/dependabot))
18
+ - Upating Rubocop configuration [\#58](https://github.com/PigCI/pig-ci-rails/pull/58) ([MikeRogers0](https://github.com/MikeRogers0))
19
+ - Making GitHub Actions versions less specific [\#57](https://github.com/PigCI/pig-ci-rails/pull/57) ([MikeRogers0](https://github.com/MikeRogers0))
20
+ - Update simplecov requirement from ~\> 0.17.0 to ~\> 0.20.0 [\#56](https://github.com/PigCI/pig-ci-rails/pull/56) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
21
+ - Update rspec requirement from ~\> 3.9.0 to ~\> 3.10.0 [\#53](https://github.com/PigCI/pig-ci-rails/pull/53) ([dependabot[bot]](https://github.com/apps/dependabot))
22
+ - Update terminal-table requirement from ~\> 1.8.0 to \>= 1.8, \< 2.1 [\#52](https://github.com/PigCI/pig-ci-rails/pull/52) ([dependabot[bot]](https://github.com/apps/dependabot))
23
+ - Revamping Github Actions [\#49](https://github.com/PigCI/pig-ci-rails/pull/49) ([MikeRogers0](https://github.com/MikeRogers0))
24
+ - Update actions/cache requirement to v2.1.2 [\#48](https://github.com/PigCI/pig-ci-rails/pull/48) ([dependabot[bot]](https://github.com/apps/dependabot))
25
+ - Update webmock requirement from ~\> 3.8.0 to ~\> 3.9.3 [\#47](https://github.com/PigCI/pig-ci-rails/pull/47) ([dependabot[bot]](https://github.com/apps/dependabot))
26
+ - Adding Dependabot.yml [\#45](https://github.com/PigCI/pig-ci-rails/pull/45) ([MikeRogers0](https://github.com/MikeRogers0))
27
+ - Ditching Docker Setup [\#44](https://github.com/PigCI/pig-ci-rails/pull/44) ([MikeRogers0](https://github.com/MikeRogers0))
28
+ - Adding funding\_uri metadata to gemspec [\#43](https://github.com/PigCI/pig-ci-rails/pull/43) ([MikeRogers0](https://github.com/MikeRogers0))
29
+ - Updating badges to reference GitHub Actions [\#42](https://github.com/PigCI/pig-ci-rails/pull/42) ([MikeRogers0](https://github.com/MikeRogers0))
30
+ - Removing Aptfile from repo [\#41](https://github.com/PigCI/pig-ci-rails/pull/41) ([MikeRogers0](https://github.com/MikeRogers0))
31
+ - Limiting GitHub Actions to just Rubocop & Rspec [\#40](https://github.com/PigCI/pig-ci-rails/pull/40) ([MikeRogers0](https://github.com/MikeRogers0))
32
+ - Updating docker setup to be a little slimmer [\#39](https://github.com/PigCI/pig-ci-rails/pull/39) ([MikeRogers0](https://github.com/MikeRogers0))
33
+ - Adding github sponsorship links [\#37](https://github.com/PigCI/pig-ci-rails/pull/37) ([MikeRogers0](https://github.com/MikeRogers0))
19
34
 
20
- ## 0.1.4
35
+ ## [v1.0.1](https://github.com/PigCI/pig-ci-rails/tree/v1.0.1) (2020-05-11)
21
36
 
22
- * [Precompile assets before tests run](https://github.com/PigCI/pig-ci-rails/pull/11)
37
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v1.0.0...v1.0.1)
23
38
 
24
- ## 0.1.3
39
+ **Merged pull requests:**
25
40
 
26
- * [Gracefully handling SockerError when submitting reports while offline](https://github.com/PigCI/pig-ci-rails/pull/7)
27
- * [Update webmock requirement from ~> 3.6.0 to ~> 3.7.0](https://github.com/PigCI/pig-ci-rails/pull/6)
41
+ - Fixing spelling in the gemspec [\#36](https://github.com/PigCI/pig-ci-rails/pull/36) ([MikeRogers0](https://github.com/MikeRogers0))
42
+ - Adding autogenerated changelog [\#35](https://github.com/PigCI/pig-ci-rails/pull/35) ([MikeRogers0](https://github.com/MikeRogers0))
43
+ - Fixing missing logo in output summary [\#34](https://github.com/PigCI/pig-ci-rails/pull/34) ([MikeRogers0](https://github.com/MikeRogers0))
44
+ - Add option to ignore cached SQL queries [\#33](https://github.com/PigCI/pig-ci-rails/pull/33) ([MikeRogers0](https://github.com/MikeRogers0))
45
+ - Skip tracking on specific tests via RSpec metadata [\#32](https://github.com/PigCI/pig-ci-rails/pull/32) ([MikeRogers0](https://github.com/MikeRogers0))
46
+ - Adding in Docker [\#31](https://github.com/PigCI/pig-ci-rails/pull/31) ([MikeRogers0](https://github.com/MikeRogers0))
47
+ - Publishing Package to PigCI account [\#28](https://github.com/PigCI/pig-ci-rails/pull/28) ([MikeRogers0](https://github.com/MikeRogers0))
28
48
 
29
- ## 0.1.2
49
+ ## [v1.0.0](https://github.com/PigCI/pig-ci-rails/tree/v1.0.0) (2020-04-07)
30
50
 
31
- * [Improving Codacy Rating](https://github.com/PigCI/pig-ci-rails/pull/4)
32
- * [Correcting issue where app warm up would negatively affect timezone](https://github.com/PigCI/pig-ci-rails/pull/5)
33
- * [Adding option to control if app is preloaded or not](https://github.com/PigCI/pig-ci-rails/pull/3)
51
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v0.2.2...v1.0.0)
34
52
 
35
- ## 0.1.1
53
+ **Merged pull requests:**
36
54
 
37
- * Updating API Endpoints for PigCI.com
38
- * Adding fallback for if API is down to not fail CI.
39
- * Removing unnecessary JS,
55
+ - Removing PigCI.com integration [\#27](https://github.com/PigCI/pig-ci-rails/pull/27) ([MikeRogers0](https://github.com/MikeRogers0))
40
56
 
41
- ## 0.1.0
57
+ ## [v0.2.2](https://github.com/PigCI/pig-ci-rails/tree/v0.2.2) (2020-03-23)
42
58
 
43
- * Initial Release
59
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v0.2.1...v0.2.2)
60
+
61
+ **Merged pull requests:**
62
+
63
+ - Fixing grammar on post\_install\_message [\#25](https://github.com/PigCI/pig-ci-rails/pull/25) ([MikeRogers0](https://github.com/MikeRogers0))
64
+
65
+ ## [v0.2.1](https://github.com/PigCI/pig-ci-rails/tree/v0.2.1) (2020-03-19)
66
+
67
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v0.2.0...v0.2.1)
68
+
69
+ **Merged pull requests:**
70
+
71
+ - Stop GitHub actions not to run on commit [\#24](https://github.com/PigCI/pig-ci-rails/pull/24) ([MikeRogers0](https://github.com/MikeRogers0))
72
+ - Handling JSON response for API key being incorrect with correct error [\#23](https://github.com/PigCI/pig-ci-rails/pull/23) ([MikeRogers0](https://github.com/MikeRogers0))
73
+
74
+ ## [v0.2.0](https://github.com/PigCI/pig-ci-rails/tree/v0.2.0) (2020-03-18)
75
+
76
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v0.1.5...v0.2.0)
77
+
78
+ **Merged pull requests:**
79
+
80
+ - Using GitHubs example for gempush.yml [\#22](https://github.com/PigCI/pig-ci-rails/pull/22) ([MikeRogers0](https://github.com/MikeRogers0))
81
+ - Replace references for limit to be threshold [\#21](https://github.com/PigCI/pig-ci-rails/pull/21) ([MikeRogers0](https://github.com/MikeRogers0))
82
+ - Setting up for 0.2.0 release [\#20](https://github.com/PigCI/pig-ci-rails/pull/20) ([MikeRogers0](https://github.com/MikeRogers0))
83
+ - Adding in action for when I tag a new version [\#19](https://github.com/PigCI/pig-ci-rails/pull/19) ([MikeRogers0](https://github.com/MikeRogers0))
84
+ - Adding config.thresholds, this allows standalone usage without pigci.com [\#18](https://github.com/PigCI/pig-ci-rails/pull/18) ([MikeRogers0](https://github.com/MikeRogers0))
85
+ - Update webmock requirement from ~\> 3.7.0 to ~\> 3.8.0 [\#17](https://github.com/PigCI/pig-ci-rails/pull/17) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
86
+ - Update rspec requirement from ~\> 3.8.0 to ~\> 3.9.0 [\#16](https://github.com/PigCI/pig-ci-rails/pull/16) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
87
+ - Updating TravisCI to test latest ruby versions [\#15](https://github.com/PigCI/pig-ci-rails/pull/15) ([MikeRogers0](https://github.com/MikeRogers0))
88
+ - Update rake requirement from ~\> 12.3 to ~\> 13.0 [\#14](https://github.com/PigCI/pig-ci-rails/pull/14) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
89
+
90
+ ## [v0.1.5](https://github.com/PigCI/pig-ci-rails/tree/v0.1.5) (2019-09-23)
91
+
92
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v0.1.4...v0.1.5)
93
+
94
+ **Merged pull requests:**
95
+
96
+ - Widen i18n gem version requirement [\#12](https://github.com/PigCI/pig-ci-rails/pull/12) ([mileszim](https://github.com/mileszim))
97
+
98
+ ## [v0.1.4](https://github.com/PigCI/pig-ci-rails/tree/v0.1.4) (2019-09-10)
99
+
100
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v0.1.3...v0.1.4)
101
+
102
+ **Implemented enhancements:**
103
+
104
+ - Precompile assets before tests run [\#11](https://github.com/PigCI/pig-ci-rails/pull/11) ([MikeRogers0](https://github.com/MikeRogers0))
105
+
106
+ **Merged pull requests:**
107
+
108
+ - Create FUNDING.yml [\#10](https://github.com/PigCI/pig-ci-rails/pull/10) ([MikeRogers0](https://github.com/MikeRogers0))
109
+
110
+ ## [v0.1.3](https://github.com/PigCI/pig-ci-rails/tree/v0.1.3) (2019-08-28)
111
+
112
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v0.1.2...v0.1.3)
113
+
114
+ **Fixed bugs:**
115
+
116
+ - Gracefully handling SockerError when submitting reports while offline [\#7](https://github.com/PigCI/pig-ci-rails/pull/7) ([MikeRogers0](https://github.com/MikeRogers0))
117
+
118
+ **Merged pull requests:**
119
+
120
+ - Adding Dependabot Status badge to readme [\#9](https://github.com/PigCI/pig-ci-rails/pull/9) ([MikeRogers0](https://github.com/MikeRogers0))
121
+ - Fixing duplicate word typo in readme [\#8](https://github.com/PigCI/pig-ci-rails/pull/8) ([MikeRogers0](https://github.com/MikeRogers0))
122
+ - Update webmock requirement from ~\> 3.6.0 to ~\> 3.7.0 [\#6](https://github.com/PigCI/pig-ci-rails/pull/6) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
123
+
124
+ ## [v0.1.2](https://github.com/PigCI/pig-ci-rails/tree/v0.1.2) (2019-08-03)
125
+
126
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v0.1.1...v0.1.2)
127
+
128
+ **Implemented enhancements:**
129
+
130
+ - Add options to control eager loading of rails app [\#3](https://github.com/PigCI/pig-ci-rails/pull/3) ([MikeRogers0](https://github.com/MikeRogers0))
131
+
132
+ **Fixed bugs:**
133
+
134
+ - Fixing issue where timezone would becomes the machines on app warmup [\#5](https://github.com/PigCI/pig-ci-rails/pull/5) ([MikeRogers0](https://github.com/MikeRogers0))
135
+
136
+ **Merged pull requests:**
137
+
138
+ - Fixing up some codacy issues [\#4](https://github.com/PigCI/pig-ci-rails/pull/4) ([MikeRogers0](https://github.com/MikeRogers0))
139
+
140
+ ## [v0.1.1](https://github.com/PigCI/pig-ci-rails/tree/v0.1.1) (2019-07-31)
141
+
142
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/v0.1.0...v0.1.1)
143
+
144
+ **Merged pull requests:**
145
+
146
+ - Adding fallback for if PigCI is have API issues [\#2](https://github.com/PigCI/pig-ci-rails/pull/2) ([MikeRogers0](https://github.com/MikeRogers0))
147
+ - Adding test coverage with codeclimate [\#1](https://github.com/PigCI/pig-ci-rails/pull/1) ([MikeRogers0](https://github.com/MikeRogers0))
148
+
149
+ ## [v0.1.0](https://github.com/PigCI/pig-ci-rails/tree/v0.1.0) (2019-07-30)
150
+
151
+ [Full Changelog](https://github.com/PigCI/pig-ci-rails/compare/26699470a370a1ff576f820a0742be5f332561be...v0.1.0)
152
+
153
+
154
+
155
+ \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
data/Gemfile CHANGED
@@ -1,4 +1,4 @@
1
- source 'https://rubygems.org'
1
+ source "https://rubygems.org"
2
2
 
3
3
  git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
4
4
 
data/README.md CHANGED
@@ -1,17 +1,35 @@
1
- [![Gem Version](https://badge.fury.io/rb/pig-ci-rails.svg)](https://badge.fury.io/rb/pig-ci-rails)
2
- [![Build Status](https://travis-ci.org/PigCI/pig-ci-rails.svg?branch=master)](https://travis-ci.org/PigCI/pig-ci-rails)
3
- [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a3ab882cc57c4cc68d7e30f25cad2568)](https://www.codacy.com/app/MikeRogers0/pig-ci-rails?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=PigCI/pig-ci-rails&amp;utm_campaign=Badge_Grade)
4
- [![Maintainability](https://api.codeclimate.com/v1/badges/d022db58c712d425dba9/maintainability)](https://codeclimate.com/github/PigCI/pig-ci-rails/maintainability)
5
- [![Test Coverage](https://api.codeclimate.com/v1/badges/d022db58c712d425dba9/test_coverage)](https://codeclimate.com/github/PigCI/pig-ci-rails/test_coverage)
6
- [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=PigCI/pig-ci-rails)](https://dependabot.com)
1
+ <h1 align="center">
2
+ PigCI
3
+ </h1>
7
4
 
8
- # PigCI
5
+ <p align="center">
6
+ Monitor your Ruby Applications metrics (Memory, SQL Requests & Request Time) as part of your test suite. If your app exceeds an acceptable threshold it'll fail the test suite.
7
+ </p>
9
8
 
10
- ![Sample Output of PigCI in TravisCI](https://user-images.githubusercontent.com/325384/64909005-7b4a1280-d6fe-11e9-8a1f-c40d21eeb4a7.png)
9
+ <p align="center">
10
+ <a target="_blank" rel="noopener noreferrer" href="https://badge.fury.io/rb/pig-ci-rails">
11
+ <img src="https://badge.fury.io/rb/pig-ci-rails.svg" alt="Gem Version" style="max-width:100%;">
12
+ </a>
13
+ <a target="_blank" rel="noopener noreferrer" href="https://github.com/PigCI/pig-ci-rails/workflows/RSpec/badge.svg">
14
+ <img src="https://github.com/PigCI/pig-ci-rails/workflows/RSpec/badge.svg" alt="RSpec" style="max-width:100%;">
15
+ </a>
16
+ <a target="_blank" rel="noopener noreferrer" href="https://github.com/PigCI/pig-ci-rails/workflows/Linters/badge.svg">
17
+ <img src="https://github.com/PigCI/pig-ci-rails/workflows/Linters/badge.svg" alt="Linters" style="max-width:100%;">
18
+ </a>
19
+ </p>
11
20
 
12
- Monitor your Ruby Applications metrics (Memory, SQL Requests & Request Time) as part of your test suite.
13
21
 
14
- Please consider supporting this project by adding [PigCI](https://pigci.com/) to your GitHub project & using this as part of CI. The CI tool will fail PRs that exceed metric threshold (e.g. a big increase in memory).
22
+ ## Deprecation notice
23
+
24
+ This gem is not longer actively maintained, I suggest using theses alternatives instead:
25
+
26
+ - [TestProf](https://github.com/test-prof/test-prof)
27
+ - [rack-mini-profiler](https://github.com/MiniProfiler/rack-mini-profiler)
28
+ - [RSpec::Benchmark](https://github.com/piotrmurach/rspec-benchmark)
29
+
30
+ ## Sample Output
31
+
32
+ ![Sample Output of PigCI in TravisCI](https://user-images.githubusercontent.com/325384/78711087-545b6400-790e-11ea-96b7-bb75c119914a.png)
15
33
 
16
34
  ## Installation
17
35
 
@@ -26,13 +44,13 @@ end
26
44
  And then execute:
27
45
 
28
46
  ```bash
29
- bundle
47
+ $ bundle
30
48
  ```
31
49
 
32
50
  Or install it yourself as:
33
51
 
34
52
  ```bash
35
- gem install pig-ci-rails
53
+ $ gem install pig-ci-rails
36
54
  ```
37
55
 
38
56
  ## Usage
@@ -76,29 +94,30 @@ PigCI.start do |config|
76
94
 
77
95
  # E.g. disable terminal summary output
78
96
  config.generate_terminal_summary = false
97
+
98
+ # Rails caches repeated SQL queries, you might want to omit these from your report.
99
+ config.ignore_cached_queries = true
79
100
  end # if RSpec.configuration.files_to_run.count > 1
80
101
  ```
81
102
 
82
103
  You can see the full configuration options [lib/pig_ci.rb](https://github.com/PigCI/pig-ci-rails/blob/master/lib/pig_ci.rb#L21).
83
104
 
105
+ ### Skipping individual tests
84
106
 
85
- ### With [PigCI.com](https://pigci.com) - For sharing runs as a team via CI
86
-
87
- _Note: This feature will be deprecated in the future. Instead use "Configuring thresholds" to have CI pass/fail._
88
-
89
- You can hookup your project to PigCI.com, this will fail PRs when metric thresholds are exceeded (e.g. your app see a big increase in memory).
107
+ If you have a scenario where you'd like PigCI to not log a specific test, you can add the RSpec metadata `pig_ci: true`. For example:
90
108
 
91
109
  ```ruby
92
- # In spec/rails_helper.rb
93
- require 'pig_ci'
94
- PigCI.start do |config|
95
- # When you connect your project, you'll be given an API key.
96
- config.api_key = 'your-api-key-here'
110
+ RSpec.describe "Comments", type: :request do
111
+ # This test block will be not be tracked.
112
+ describe "GET #index", pig_ci: false do
113
+ it do
114
+ get comments_path
115
+ expect(response).to be_successful
116
+ end
117
+ end
97
118
  end
98
119
  ```
99
120
 
100
- It's a great way to track metrics over time & support this project.
101
-
102
121
  ### Framework support
103
122
 
104
123
  Currently this gem only supports Ruby on Rails tested via RSpec.
@@ -146,17 +165,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
146
165
 
147
166
  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).
148
167
 
149
- ## TODO
150
-
151
- Features I'd like to add at some point:
152
-
153
- * Add support for "upsert" for when tests are split over multiple machines
154
- * HTML output to include branch - Right now they're just timestamps which makes filtering hard.
155
- * Document setting branch/commit to handle when CI doesn't set it correctly.
156
- * Add rake for submitting reports.
157
- * https://rubydoc.info/gems/yard/file/docs/GettingStarted.md - Document the gem so it's easier for people to jump on.
158
- * Support ActionCable (when requests have no key).
159
-
160
168
  ## Contributing
161
169
 
162
170
  Bug reports and pull requests are welcome on GitHub at [PigCI/pig-ci-rails](https://github.com/PigCI/pig-ci-rails). 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.