Deployed e55bf21 with MkDocs version: 1.4.2

rolling_back/index.html

@@ -1042,6 +1042,10 @@ <h1>Rolling back nodes and media</h1>
 <p>By default, the configuration file is named "rollback.yml" and is written into the Workbench directory. The input CSV file is named "rollback.csv" and is written into the directory defined in your <code>input_dir</code> configuration setting. If either of these files exist, they are overwritten during the next <code>create</code> or <code>create_from_files</code> task.</p>
 <p>To roll back all the nodes and media you just created, run <code>./workbench --config rollback.yml</code>.</p>
 <p>There are several configuration settings that let you control the names of these two files, and there is also an option to include comments in the files.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>When secondary tasks are configured, each task will get its own rollback file. Each secondary task's rollback file will have a normalized version of the path to the task's configuration file appended to the rollback filename, e.g., <code>rollback.csv.home_mark_hacking_islandora_workbench_example_secondary_task</code>. Using these separate rollback files, you can delete only the nodes created in a specific secondary task.</p>
+</div>
 <h2 id="setting-the-directory-where-the-rollback-cvs-file-is-written">Setting the directory where the rollback CVS file is written</h2>
 <p>You can determine where the rollback CSV file is written by including the <code>rollback_dir</code> in your configuration. This overrides the default location defined in <code>input_dir</code>.</p>
 <p>The rollback configuration file is always written to the Workbench working directory.</p>
@@ -1064,10 +1068,21 @@ <h2 id="adding-a-timestamp-to-the-rollback-filenames">Adding a timestamp to the
 <p>By default, Workbench overwrites the rollback configuration and CSV files each time it runs, so these files only apply to the most recent <code>create</code> and <code>create_from_files</code> runs. If you add <code>timestamp_rollback: true</code> to your configuration file, a (to-the-second) timestamp will be added to the <code>rollback.yml</code> and corresponding <code>rollback.csv</code> files, for example, <code>rollback.2024_11_03_21_10_28.yml</code> and <code>rollback.2024_11_03_21_10_28.csv</code>. The name of the CSV is also written to <code>workbench.log</code>. Running <code>./workbench --config rollback.2024_11_03_21_10_28.yml</code> will delete the nodes identified in <code>input_data/rollback.2024_11_03_21_10_28.csv</code>.</p>
 <p>Timestamps are added in the same way to custom rollback configuration and CSV filenames create using templates.</p>
 <h2 id="adding-custom-comments-to-your-rollback-configuration-and-csv-files">Adding custom comments to your rollback configuration and CSV files</h2>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>When secondary tasks are configured, each task will get its own rollback file. Each secondary task's rollback file will have a normalized version of the path to the task's configuration file appended to the rollback filename, e.g., <code>rollback.csv.home_mark_hacking_islandora_workbench_example_secondary_task</code>. Using these separate rollback files, you can delete only the nodes created in a specific secondary task.</p>
-</div>
+<p>Workbench always adds to lines of comments to rollback configuration and CSV files, indicating when the files were generated and the names of the configuration and input CSV files they were generated from, like this:</p>
+<pre><code># Generated by a &quot;create&quot; task started 2024:11:10 09:52:57 using
+# config file &quot;mjtest.yml&quot; and input CSV &quot;sample.csv&quot;.
+</code></pre>
+<p>You can add additional, custom comment lines by including the <code>rollback_file_comments</code> configuration setting in your <code>create</code> or <code>create_from_files</code> configuration, like this:</p>
+<pre><code>rollback_file_comments:
+  - Keep this file! It might be useful if something goes wrong with this job.
+  - Have a nice day!
+</code></pre>
+<p>This will result in the following comments in your rollback configuration and CSV files:</p>
+<pre><code># Generated by a &quot;create&quot; task started 2024:11:10 09:52:57 using
+# config file &quot;mjtest.yml&quot; and input CSV &quot;sample.csv&quot;.
+# Keep this file! It might be useful if something goes wrong with this job.
+# Have a nice day!
+</code></pre>