Skip to content
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

Jump to bottom

Remove prefixed $ from shell command examples #610

Merged
merged 2 commits into from
Apr 14, 2022
Merged

Remove prefixed $ from shell command examples #610

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2fc271
Remove prefixed $ from shell command examples
larouxn Apr 12, 2022
48fd69b
Replace bash with sh-session
larouxn Apr 14, 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
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ A Rails engine for queuing and managing maintenance tasks.
To install the gem and run the install generator, execute:

```bash
$ bundle add maintenance_tasks
$ bin/rails generate maintenance_tasks:install
bundle add maintenance_tasks
bin/rails generate maintenance_tasks:install
```

The generator creates and runs a migration to add the necessary table to your
Expand Down Expand Up @@ -40,7 +40,7 @@ take a look at the [Active Job documentation][active-job-docs].
A generator is provided to create tasks. Generate a new task by running:

```bash
$ bin/rails generate maintenance_tasks:task update_posts
bin/rails generate maintenance_tasks:task update_posts
```

This creates the task file `app/tasks/maintenance/update_posts_task.rb`.
Expand Down Expand Up @@ -87,7 +87,7 @@ instuctions][setup].
Generate a CSV Task by running:

```bash
$ bin/rails generate maintenance_tasks:task import_posts --csv
bin/rails generate maintenance_tasks:task import_posts --csv
```

The generated task is a subclass of `MaintenanceTasks::Task` that implements:
Expand Down Expand Up @@ -196,7 +196,7 @@ collection-less tasks.
Generate a collection-less Task by running:

```bash
$ bin/rails generate maintenance_tasks:task no_collection_task --no-collection
bin/rails generate maintenance_tasks:task no_collection_task --no-collection
```

The generated task is a subclass of `MaintenanceTasks::Task` that implements:
Expand Down Expand Up @@ -484,20 +484,20 @@ You can run your new Task by accessing the Web UI and clicking on "Run".
Alternatively, you can run your Task in the command line:

```bash
$ bundle exec maintenance_tasks perform Maintenance::UpdatePostsTask
bundle exec maintenance_tasks perform Maintenance::UpdatePostsTask
```

To run a Task that processes CSVs from the command line, use the --csv option:

```bash
$ bundle exec maintenance_tasks perform Maintenance::ImportPostsTask --csv "path/to/my_csv.csv"
bundle exec maintenance_tasks perform Maintenance::ImportPostsTask --csv "path/to/my_csv.csv"
```

To run a Task that takes arguments from the command line, use the --arguments
option, passing arguments as a set of \<key>:\<value> pairs:

```bash
$ bundle exec maintenance_tasks perform Maintenance::ParamsTask \
bundle exec maintenance_tasks perform Maintenance::ParamsTask \
--arguments post_ids:1,2,3 content:"Hello, World!"
```

Expand Down Expand Up @@ -746,7 +746,7 @@ Use bundler to check for and upgrade to newer versions. After installing a new
version, re-run the install command:

```bash
$ bin/rails generate maintenance_tasks:install
bin/rails generate maintenance_tasks:install
```

This ensures that new migrations are installed and run as well.
Expand Down