Skip to content

Jskinne3 add jobs to readme #7288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jskinne3 merged 6 commits into from
Nov 4, 2022
Merged

Jskinne3 add jobs to readme #7288

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e1a9a0c
Add background jobs command to README
jskinne3 Nov 3, 2022
b77e864
Document async flag
jskinne3 Nov 3, 2022
80abb1a
[skip changelog]
jskinne3 Nov 3, 2022
58fc302
Add note about Procfile
jskinne3 Nov 3, 2022
caf2634
Link to Procfile as example
jskinne3 Nov 3, 2022
72c975a
Explain that make run runs the Procfile
jskinne3 Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,12 @@ If you'd like to work with the previous implementation see the [Docker documenta

Run `make lint`

### Running jobs

We run background jobs / workers with ActiveJob and GoodJob. You shouldn't normally have to start it manually because `make run` runs [the `Procfile`](Procfile), which handles it. The manual command is: `bundle exec good_job start`

Processes can be configured to run via async jobs or synchronously using flags such as `deliver_mail_async` in [application.yml](config/application.yml.default)

### Troubleshooting
#### I am receiving errors when running `$ make setup`

Expand Down