updated readme

README.md

@@ -1,17 +1,18 @@
 # YAPF Code Formatter GitHub Action
 
-A GitHub action that runs [YAPF code formatter](https://github.com/google/yapf) for Python.
+A [GitHub action](https://github.com/diegovalenzuelaiturra/yapf-action) that runs [YAPF code formatter](https://github.com/google/yapf) for Python.
 
 It will automatically commit the changes!
 
+An example worflow can be found at `.github/workflows/main.yml`
+
 ## Example Workflow
 
 On your repo, create a folder called `.github/workflows/` containing a `main.yml` file, with the following workflow configurations :
 
 ```yaml
 name: YAPF Formatter
 
-# the workflow is triggered on pushes and applied to python files
 on:
   push:
     paths:
@@ -20,38 +21,68 @@ on:
 jobs:
   build:
     name: YAPF Formatter
-    # the workflow runs on ubuntu
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - name: checkout repo
+        uses: actions/[email protected]
+        with:
+          repository: ${{ github.repository }}
+          token: ${{ github.token }}
+
+      # https://github.com/diegovalenzuelaiturra/yapf-action
       - name: YAPF Formatter
-        # This step uses diegovalenzuelaiturra's yapf-action:
-        #   https://github.com/diegovalenzuelaiturra/yapf-action
         uses: diegovalenzuelaiturra/yapf-action@master
         with:
-          args: . --verbose --recursive --in-place
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          args: . --verbose --recursive --in-place --parallel
 
-      - name: Commit files
+      - name: action metadata
+        # github.action     : the name of the action currently running.
+        # github.actor      : the login of the user that initiated the workflow run.
+        # github.event_name : The name of the event that triggered the workflow run.
+        # github.job        : The job_id of the current job.
+        # github.ref        : The branch or tag ref that triggered the workflow run.
+        # github.repository : The owner and repository name.
+        # github.run_id     : A unique number for each run within a repository. This number does not change if you re-run the workflow run.
+        # github.sha        : The commit SHA that triggered the workflow run.
+        # github.workflow   : The name of the workflow. If the workflow file doesn't specify a name, the value of this property is the full path of the workflow file in the repository.
+        # github.workspace  : The default working directory for steps and the default location of your repository when using the checkout action.
+        run: |
+          echo -e "action     : ${{ github.action }}"
+          echo -e "actor      : ${{ github.actor }}"
+          echo -e "event_name : ${{ github.event_name }}"
+          echo -e "job        : ${{ github.job }}"
+          echo -e "ref        : ${{ github.ref }}"
+          echo -e" repository : ${{ github.repository }}"
+          echo -e "run_id     : ${{ github.run_id }}"
+          echo -e "sha        : ${{ github.sha }}"
+          echo -e "workflow   : ${{ github.workflow }}"
+          echo -e "workspace  : ${{ github.workspace }}"
+
+      - name: config github
+        run: |
+          git config user.name github-actions
+          git config user.email [email protected]
+
+      - name: add changes
         run: |
-          echo ${{ github.ref }}
           git add .
-          git config --local user.email "[email protected]"
-          git config --local user.name "GitHub Action"
-          git commit -m "Automated Formatter Push" -a | exit 0
 
-      - name: Push changes
+      - name: commit changes
+        run: |
+          git commit -m "Automation: YAPF Formatter" --all | exit 0
+
+      # NOTE : only push changes when the source branch is being pushed to master (target branch)
+      - name: push changes
         if: github.ref == 'refs/heads/master'
-        uses: ad-m/github-push-action@master
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git push
 ```
 
 If you want to edit the message it will automatically commit to your repository when pushing the changes, edit the following command of the worflow to include your own custom message:
 
 ```bash
-git commit -m "Automated Formatter Push" -a | exit 0
+git commit -m "Automation: YAPF Formatter" --all | exit 0
 ```
 
 For a full list of possible args checkout the [YAPF docs](https://github.com/google/yapf#Usage).