-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
20 changed files
with
241 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
bump: | ||
file: lib/isolator/version.rb | ||
skip_ci: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: palkan | ||
|
||
--- | ||
|
||
## What did you do? | ||
|
||
## What did you expect to happen? | ||
|
||
## What actually happened? | ||
|
||
## Additional context | ||
|
||
## Environment | ||
|
||
**Ruby Version:** | ||
|
||
**Framework Version (Rails, whatever):** | ||
|
||
**Isolator Version:** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: palkan | ||
|
||
--- | ||
|
||
## Is your feature request related to a problem? Please describe. | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## Describe the solution you'd like | ||
|
||
A clear and concise description of what you want to happen. | ||
|
||
## Describe alternatives you've considered | ||
|
||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
## Additional context | ||
|
||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- | ||
First of all, thanks for contributing! | ||
If it's a typo fix or minor documentation update feel free to skip the rest of this template! | ||
--> | ||
|
||
## What is the purpose of this pull request? | ||
|
||
<!-- | ||
If it's a bug fix, then link it to the issue, for example: | ||
Fixes #xxx | ||
--> | ||
|
||
## What changes did you make? (overview) | ||
|
||
## Is there anything you'd like reviewers to focus on? | ||
|
||
## Checklist | ||
|
||
- [ ] I've added tests for this change | ||
- [ ] I've added a Changelog entry | ||
- [ ] I've updated a documentation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
name: Build | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
pull_request: | ||
|
||
jobs: | ||
rspec: | ||
runs-on: ubuntu-latest | ||
env: | ||
BUNDLE_JOBS: 4 | ||
BUNDLE_RETRY: 3 | ||
CI: true | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
ruby: ["2.7"] | ||
gemfile: ["gemfiles/rails6.gemfile"] | ||
include: | ||
- ruby: "2.5" | ||
gemfile: "gemfiles/rails5.gemfile" | ||
- ruby: "2.6" | ||
gemfile: "gemfiles/rails5.gemfile" | ||
- ruby: "2.7" | ||
gemfile: "gemfiles/railsmaster.gemfile" | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/cache@v1 | ||
with: | ||
path: /home/runner/bundle | ||
key: bundle-${{ matrix.ruby }}-${{ matrix.gemfile }}-${{ hashFiles(matrix.gemfile) }}-${{ hashFiles('**/*.gemspec') }} | ||
restore-keys: | | ||
bundle-${{ matrix.ruby }}-${{ matrix.gemfile }}- | ||
- uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: ${{ matrix.ruby }} | ||
- name: Bundle install | ||
run: | | ||
bundle config path /home/runner/bundle | ||
bundle config --global gemfile ${{ matrix.gemfile }} | ||
bundle install | ||
bundle update | ||
- name: Run RSpec | ||
run: | | ||
bundle exec rspec |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: Lint Ruby | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
pull_request: | ||
|
||
jobs: | ||
rubocop: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: 2.7 | ||
- name: Lint Ruby code with RuboCop | ||
run: | | ||
gem install bundler | ||
bundle install --gemfile gemfiles/rubocop.gemfile --jobs 4 --retry 3 | ||
bundle exec --gemfile gemfiles/rubocop.gemfile rubocop |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
rules "~MD013", "~MD033" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
-f d | ||
--color |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
inherit_from: ".rubocop.yml" | ||
|
||
require: | ||
- rubocop-md | ||
|
||
AllCops: | ||
Include: | ||
- '**/*.md' | ||
|
||
Lint/Void: | ||
Exclude: | ||
- '**/*.md' | ||
|
||
Lint/DuplicateMethods: | ||
Exclude: | ||
- '**/*.md' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,20 @@ | ||
source "https://rubygems.org" | ||
# frozen_string_literal: true | ||
|
||
git_source(:github) { |repo_name| "https://github.com/#{repo_name}" } | ||
source 'https://rubygems.org' | ||
|
||
# Specify your gem's dependencies in isolator.gemspec | ||
gemspec | ||
gem 'pry-byebug', platform: :mri | ||
|
||
gem "pry-byebug" | ||
gemspec | ||
|
||
gem "sqlite3", "~> 1.4.0" | ||
eval_gemfile "gemfiles/rubocop.gemfile" | ||
|
||
local_gemfile = File.join(__dir__, "Gemfile.local") | ||
local_gemfile = "#{File.dirname(__FILE__)}/Gemfile.local" | ||
|
||
if File.exist?(local_gemfile) | ||
eval(File.read(local_gemfile)) # rubocop:disable Security/Eval | ||
else | ||
gem "rails", "~> 6.0" | ||
gem 'rails', '~> 6.0' | ||
gem 'sqlite3', '~> 1.4.0' | ||
end | ||
|
||
gem 'uniform_notifier', '~> 1.11' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# How to release a gem | ||
|
||
This document describes a process of releasing a new version of a gem. | ||
|
||
1. Bump version. | ||
|
||
```sh | ||
git commit -m "Bump 1.<x>.<y>" | ||
``` | ||
|
||
We're (kinda) using semantic versioning: | ||
|
||
- Bugfixes should be released as fast as possible as patch versions. | ||
- New features could be combined and released as minor or patch version upgrades (depending on the _size of the feature_—it's up to maintainers to decide). | ||
- Breaking API changes should be avoided in minor and patch releases. | ||
- Breaking dependencies changes (e.g., dropping older Ruby support) could be released in minor versions. | ||
|
||
How to bump a version: | ||
|
||
- Change the version number in `lib/isolator/version.rb` file. | ||
- Update the changelog (add new heading with the version name and date). | ||
- Update the installation documentation if necessary (e.g., during minor and major updates). | ||
|
||
2. Push code to GitHub and make sure CI passes. | ||
|
||
```sh | ||
git push | ||
``` | ||
|
||
3. Release a gem. | ||
|
||
```sh | ||
gem release -t | ||
git push --tags | ||
``` | ||
|
||
We use [gem-release](https://github.com/svenfuchs/gem-release) for publishing gems with a single command: | ||
|
||
```sh | ||
gem release -t | ||
``` | ||
|
||
Don't forget to push tags and write release notes on GitHub (if necessary). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
source 'https://rubygems.org' | ||
|
||
gem 'rails', '~> 6.0' | ||
|
||
gemspec path: '..' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
source "https://rubygems.org" do | ||
gem "rubocop-md", "~> 0.3" | ||
gem "standard", "~> 0.5.0" | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters