ci: update and enhance template workflow

Updated the workflow YAML file to improve structure and readability. Changes included adding more detailed comments, giving clearer names to jobs and steps, defining sequences, and modifying push actions. Split commit and push actions into separate steps for better workflow control.

Author: nekofar

.github/workflows/template.yml

@@ -1,51 +1,57 @@
-# Workflow Name
+# Assign a name to the workflow.
 name: Template Cleanup
 
-# Trigger the workflow on push events to the master branch
+# Specify when this workflow is going to be triggered.
 on:
+  # In this case, the workflow will be triggered whenever there is a push to the master branch.
   push:
     branches: [master]
 
-# Define jobs
+# Define the jobs that this workflow will perform.
 jobs:
-  # Cleanup job
+  # Declare a job named 'cleanup'.
   cleanup:
-    # Job runs on the latest Ubuntu version
+    # Specify the type of runner that the job should run on - Latest version of Ubuntu.
     runs-on: ubuntu-latest
 
-    # Permissions
+    # Define permissions for this job.
     permissions:
       contents: write
 
-    # Conditional check
+    # A conditional check to ensure the job runs only if the name of the repository meets the constraint.
     if: github.repository != 'nekofar/nextjs-lingui-template'
 
-    # Steps instances
+    # Define the steps to be followed in this job.
     steps:
+      # Checkout the code.
       - name: Checkout code
         uses: actions/[email protected]
 
+      # Set up Node.js environment.
       - name: Set up Node.js environment
         uses: actions/[email protected]
 
-      - name: Install pnpm package manager # Install pnpm
+      # Install pnpm package manager.
+      - name: Install pnpm package manager
         uses: pnpm/[email protected]
         with:
           version: ^8
           run_install: false
 
+      # Clean up the repository.
       - name: Clean up the repository
+        # The 'run:' statement let's you execute commands directly.
         run: |
-          # Declare variables
+          # Declare and assign local variables.
           NAME="$(basename $GITHUB_REPOSITORY)"
           VERSION='1.0.0-alpha.0'
 
-          # Replace package.json name and version fields
+          # Use pnpm dlx json to modify package.json name and version fields.
           pnpm dlx json -I -f package.json -e "this.name='${NAME}'"
           pnpm dlx json -I -f package.json -e "this.version='${VERSION}'"
           pnpm dlx install --no-frozen-lockfile  # Install dependencies (ignoring lock file)
 
-          # Remove unnecessary files
+          # Remove template specific files and directories.
           rm -rf \
             .github/ISSUE_TEMPLATE \
             .github/workflows/template.yml \
@@ -55,7 +61,17 @@ jobs:
             CHANGELOG.md \
             README.md
 
-      - name: Create Pull Request # Generate a pull request
-        uses: peter-evans/[email protected]
+      # Commit the changes made to the repository.
+      - name: Commit files
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add .
+          git commit -m 'chore: initial template cleanup'
+
+      # Push the changes to the repository.
+      - name: Push changes
+        uses: ad-m/github-push-action@master
         with:
-          commit-message: 'chore: initial template cleanup' # Commit message
+          branch: master
+          github_token: ${{ secrets.GITHUB_TOKEN }}