Skip to content

Commit

Permalink
Merge pull request #1 from SOFware/update-readme
Browse files Browse the repository at this point in the history
Update readme to include missing steps
  • Loading branch information
xsavvyx authored May 16, 2023
2 parents a94d835 + 73c2338 commit a195659
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,20 @@ Add to your `spec_helper.rb` or `rails_helper.rb`:

```
require "chat_notifier/rspec_formatter"
config.add_formatter "ChatNotifier::RspecFormatter" if ENV["CI"]
```

Add to your config/application.rb within your namespaced module

```
def self.sha
`git rev-parse --short HEAD`.chomp
end
def self.branch
`git branch --show-current`.chomp
end
```

### Debug your Slack setup
Expand All @@ -22,6 +36,7 @@ Create rake task to test the connection to your Slack channel

```ruby
namespace :chat_notifier do
desc "Tests chat notifier"
task debug: :environment do
unless ENV["SLACK_WEBHOOK_URL"]
puts "You MUST set the environment variables for:\nSLACK_WEBHOOK_URL"
Expand Down

0 comments on commit a195659

Please sign in to comment.