Merge branch 'master' into dependabot/github_actions/all-actions-c95a42c707

Author: DomT4

.github/generate-help-output.py

@@ -15,14 +15,13 @@ def remove_ansi_escape_codes(text):
 with open(readme_file, "r") as f:
     readme_content = f.read()
 
-start_comment_tag = "<!-- HELP-COMMAND-OUTPUT:START -->"
-stop_comment_tag = "<!-- HELP-COMMAND-OUTPUT:END -->"
+start_comment_tag = "[comment]: # (HELP-COMMAND-OUTPUT:START)"
+stop_comment_tag = "[comment]: # (HELP-COMMAND-OUTPUT:END)"
 
 comment_tag_pattern = rf"{start_comment_tag}(.*?){stop_comment_tag}"
 tag_section_content = re.search(comment_tag_pattern, readme_content, re.DOTALL)
 
 if tag_section_content:
-
     try:
         help_command_output_new = subprocess.check_output(["brew", "autoupdate", "--help"], text=True)
     except subprocess.CalledProcessError as e:
@@ -32,7 +31,7 @@ def remove_ansi_escape_codes(text):
     help_command_output_current = tag_section_content.group(1).strip()
     help_command_output_new = remove_ansi_escape_codes(help_command_output_new.strip())
 
-    start_code_pattern = "```shell"
+    start_code_pattern = "```help"
     end_code_pattern = "```"
 
     # Regex to check if the existing help section is in a shell code block
@@ -41,13 +40,13 @@ def remove_ansi_escape_codes(text):
 
     if help_command_output_current != help_command_output_new:
         print("Content change detected.")
-        help = f"{start_comment_tag}\n{start_code_pattern}\n{help_command_output_new}\n{end_code_pattern}\n{stop_comment_tag}"
+        help = f"{start_comment_tag}\n\n{start_code_pattern}\n{help_command_output_new}\n{end_code_pattern}\n\n{stop_comment_tag}"
         readme_content = re.sub(comment_tag_pattern, help, readme_content, flags=re.DOTALL)
         print("Content updated.")
 
         # Set GitHub Actions output variable
         with open(os.environ['GITHUB_OUTPUT'], 'a') as fh:
-            print(f'changed=true', file=fh)
+            print('changed=true', file=fh)
     else:
         print("No change detected. Content remains unchanged.")
 else:

README.md

@@ -20,18 +20,21 @@ Now run `brew autoupdate start [interval] [options]` to enable autoupdate.
 
 ## Example
 
-`brew autoupdate start 43200 --upgrade --cleanup --immediate --sudo`
+```sh
+brew autoupdate start 43200 --upgrade --cleanup --immediate --sudo
+```
 
-This will upgrade all your casks and formulae every 12 hours and on every system boot. <br>
-If a sudo password is required for an upgrade, a GUI to enter your password will be displayed. <br>
+This will upgrade all your casks and formulae every 12 hours and on every system boot.  
+If a sudo password is required for an upgrade, a GUI to enter your password will be displayed.  
 Also, it will clean up every old version and left-over files.
 
 Casks that have built-in auto-updates enabled by default will not be upgraded.
 
 ## Usage
 
-<!-- HELP-COMMAND-OUTPUT:START -->
-```shell
+[comment]: # (HELP-COMMAND-OUTPUT:START)
+
+```help
 Usage: brew autoupdate subcommand [interval] [options]
 
 An easy, convenient way to automatically update Homebrew.
@@ -81,7 +84,8 @@ brew autoupdate version:
   -v, --verbose                    Make some output more verbose.
   -h, --help                       Show this message.
 ```
-<!-- HELP-COMMAND-OUTPUT:END -->
+
+[comment]: # (HELP-COMMAND-OUTPUT:END)
 
 **Logs of the performed operations can be found at:** `~/Library/Logs/com.github.domt4.homebrew-autoupdate`
 
@@ -97,13 +101,13 @@ the built-in autoupdate mechanism, which can be instructed to autoupdate less
 often, or disabled entirely. If you wish to update every 24 hours using the
 built-in autoupdate mechanism set this in your environment:
 
-```bash
+```sh
 export HOMEBREW_AUTO_UPDATE_SECS="86400"
 ```
 
 or if you wish to disable the built-in autoupdate mechanism entirely:
 
-```bash
+```sh
 export HOMEBREW_NO_AUTO_UPDATE="1"
 ```
 
@@ -126,4 +130,4 @@ the wider Homebrew leadership team in terms of maintenance/support requests.
 
 ## License
 
-Code is under the [BSD 2 Clause (NetBSD) license](https://github.com/DomT4/homebrew-autoupdate/blob/master/LICENSE.txt).
+Code is under the [BSD 2 Clause (NetBSD) license](https://github.com/DomT4/homebrew-autoupdate/blob/master/LICENSE.txt).