feat: Add option for readme path and refactor readme update (#16)

Author: DenverCoder1

Diff for: action.py

@@ -116,16 +116,15 @@ def parse_video(self, video: Dict[str, Any]) -> str:
                 params["duration"] = self.parse_iso8601_duration(content_details["duration"])
         # translate video to standard markdown
         backslash_escaped_title = params["title"].replace('"', '\\"')
-        result = f'[![{params["title"]}]({self._base_url}?{urllib.parse.urlencode(params)} "{backslash_escaped_title}")]({video["link"]})'
         # if theme context is set, create two versions with theme context specified
         if self._theme_context_dark or self._theme_context_light:
             dark_params = params | self._theme_context_dark
             light_params = params | self._theme_context_light
-            result = (
+            return (
                 f'[![{params["title"]}]({self._base_url}?{urllib.parse.urlencode(dark_params)} "{backslash_escaped_title}")]({video["link"]}#gh-dark-mode-only)'
                 f'[![{params["title"]}]({self._base_url}?{urllib.parse.urlencode(light_params)} "{backslash_escaped_title}")]({video["link"]}#gh-light-mode-only)'
             )
-        return result.replace("/", "\\/").replace("'", "\\'")
+        return f'[![{params["title"]}]({self._base_url}?{urllib.parse.urlencode(params)} "{backslash_escaped_title}")]({video["link"]})'
 
     def parse_videos(self) -> str:
         """Parse video feed and return the contents for the readme"""
@@ -136,6 +135,25 @@ def parse_videos(self) -> str:
         return "\n".join(map(self.parse_video, videos))
 
 
+class FileUpdater:
+    """Update the readme file"""
+
+    @staticmethod
+    def update(readme_path: str, comment_tag: str, replace_content: str):
+        """Replace the text between the begin and end tags with the replace content"""
+        begin_tag = f"<!-- BEGIN {comment_tag} -->"
+        end_tag = f"<!-- END {comment_tag} -->"
+        with open(readme_path, "r") as readme_file:
+            readme = readme_file.read()
+        begin_index = readme.find(begin_tag)
+        end_index = readme.find(end_tag)
+        if begin_index == -1 or end_index == -1:
+            raise RuntimeError(f"Could not find tags {begin_tag} and {end_tag} in {readme_path}")
+        readme = f"{readme[:begin_index + len(begin_tag)]}\n{replace_content}\n{readme[end_index:]}"
+        with open(readme_path, "w") as readme_file:
+            readme_file.write(readme)
+
+
 if __name__ == "__main__":
     parser = ArgumentParser()
     parser.add_argument(
@@ -144,6 +162,12 @@ def parse_videos(self) -> str:
         help="YouTube channel ID",
         required=True,
     )
+    parser.add_argument(
+        "--comment-tag-name",
+        dest="comment_tag_name",
+        help="Comment tag name",
+        default="YOUTUBE-CARDS",
+    )
     parser.add_argument(
         "--max-videos",
         dest="max_videos",
@@ -207,6 +231,12 @@ def parse_videos(self) -> str:
         default="false",
         choices=("true", "false"),
     )
+    parser.add_argument(
+        "--readme-path",
+        dest="readme_path",
+        help="Path to the readme file",
+        default="README.md",
+    )
     args = parser.parse_args()
 
     if args.show_duration == "true" and not args.youtube_api_key:
@@ -226,4 +256,10 @@ def parse_videos(self) -> str:
         theme_context_dark=json.loads(args.theme_context_dark),
     )
 
-    print(video_parser.parse_videos())
+    video_content = video_parser.parse_videos()
+
+    # output to stdout
+    print(video_content)
+
+    # update the readme file
+    FileUpdater.update(args.readme_path, args.comment_tag_name, video_content)

Diff for: action.yml

@@ -65,6 +65,10 @@ inputs:
     description: "The commit message to use for the commit"
     required: false
     default: "docs(readme): Update YouTube cards"
+  readme_path:
+    description: "The path to the readme file"
+    required: false
+    default: "README.md"
 
 runs:
   using: "composite"
@@ -84,20 +88,22 @@ runs:
     - name: Generate Readme Update
       id: "generate-readme-update"
       shell: bash
-      run: echo ::set-output name=readme_update::$(python ${{ github.action_path }}/action.py --channel "${{ inputs.channel_id }}" --max-videos ${{ inputs.max_videos }} --base-url "${{ inputs.base_url }}" --card-width ${{ inputs.card_width }} --background-color "${{ inputs.background_color }}" --title-color "${{ inputs.title_color }}" --stats-color "${{ inputs.stats_color }}" --youtube-api-key "${{ inputs.youtube_api_key }}" --show-duration "${{ inputs.show_duration }}" --theme-context-light '${{ inputs.theme_context_light }}' --theme-context-dark '${{ inputs.theme_context_dark }}')
-
-    - name: Update README
-      shell: bash
-      env:
-        BEGIN_TAG: "<!-- BEGIN ${{ inputs.comment_tag_name }} -->"
-        END_TAG: "<!-- END ${{ inputs.comment_tag_name }} -->"
       run: |
-        if [ -z '${{ steps.generate-readme-update.outputs.readme_update }}' ]; then
-          echo "Python script finished with no output. Exiting with error."
-          exit 1
-        fi
-        UPDATE=$(cat README.md | perl -0777 -pe 's/(${{ env.BEGIN_TAG }})(?:.|\n)*?(${{ env.END_TAG }})/${1}\n${{ steps.generate-readme-update.outputs.readme_update }}\n${2}/g')
-        echo "${UPDATE}" > README.md
+        UPDATE=$(python ${{ github.action_path }}/action.py \
+                --channel "${{ inputs.channel_id }}" \
+                --comment-tag-name "${{ inputs.comment_tag_name }}" \
+                --max-videos ${{ inputs.max_videos }} \
+                --base-url "${{ inputs.base_url }}" \
+                --card-width ${{ inputs.card_width }} \
+                --background-color "${{ inputs.background_color }}" \
+                --title-color "${{ inputs.title_color }}" \
+                --stats-color "${{ inputs.stats_color }}" \
+                --youtube-api-key "${{ inputs.youtube_api_key }}" \
+                --show-duration "${{ inputs.show_duration }}" \
+                --theme-context-light '${{ inputs.theme_context_light }}' \
+                --theme-context-dark '${{ inputs.theme_context_dark }}' \
+                --readme-path "${{ inputs.readme_path }}" \
+        ) || exit 1
 
     - name: Commit changes
       uses: EndBug/add-and-commit@v9