You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
`danger-packwerk` integrates [`packwerk`](https://github.com/Shopify/packwerk) with [`danger`](https://github.com/danger/danger) to provide inline comments in PRs related to boundaries in a Rails application.
4
4
5
5
## Installation and Basic Usage
6
-
Step 1: Add this line to your `Gemfile` (to whatever group your CI uses, as it is not needed in production) and `bundle install`:
6
+
Step 1: Add this line to your `Gemfile` (to whatever group your CI uses, as it is not needed in production) and run `bundle install`:
7
7
8
8
```ruby
9
9
gem 'danger-packwerk', group::test
@@ -30,11 +30,11 @@ In upcoming iterations, we will include other danger checks, including:
30
30
31
31
## packwerk.check
32
32

33
-

33
+

34
34
35
35
Without any configuration, `packwerk.check` should just work. By default, it will post a maximum of 15 messages in a PR and it will not fail the build.
36
36
37
-
`packwerk.check` can be configured to in the following ways:
37
+
`packwerk.check` can be configured in the following ways:
38
38
39
39
### Change the message that displays in the markdown
40
40
To customize the message in the GitHub comment, pass in `offenses_formatter` to `packwerk.check` in your `Dangerfile`. Here's a simple example:
@@ -108,7 +108,7 @@ You will also most likely want to customize the offenses formatter and provide s
108
108
109
109
Without any configuration, `package_todo_yml_changes.check` should just work. By default, it will post a maximum of 15 messages in a PR, using default messaging defined within this gem.
110
110
111
-
`package_todo_yml_changes.check` can be configured to in the following ways:
111
+
`package_todo_yml_changes.check` can be configured in the following ways:
112
112
113
113
### Change the message that displays in the markdown
114
114
To customize the message in the GitHub comment, pass in `offenses_formatter` to `package_todo_yml_changes.check` in your `Dangerfile`. Here's a simple example:
0 commit comments