Updated README with commit-tag instruction

README.md

@@ -11,64 +11,82 @@ Please bear in mind: files in the target repository's specified directory are de
 There are different variables to setup the behaviour:
 
 ## Inputs
+
 ### `source-directory` (argument)
+
 From the repository that this Git Action is executed the directory that contains the files to be pushed into the repository.
 
 ### `destination-github-username` (argument)
+
 For the repository `https://github.com/cpina/push-to-another-repository-output` is `cpina`.
 
 ### `destination-repository-name` (argument)
+
 For the repository `https://github.com/cpina/push-to-another-repository-output` is `push-to-another-repository-output`
 
-*Warning:* this Github Action currently deletes all the files and directories in the destination repository. The idea is to copy from an `output` directory into the `destination-repository-name` having a copy without any previous files there.
+_Warning:_ this Github Action currently deletes all the files and directories in the destination repository. The idea is to copy from an `output` directory into the `destination-repository-name` having a copy without any previous files there.
 
 ### `user-email` (argument)
+
 The email that will be used for the commit in the destination-repository-name.
 
 ### `user-name` (argument) [optional]
+
 The name that will be used for the commit in the destination-repository-name. If not specified, the `destination-github-username` will be used instead.
 
 ### `destination-repository-username` (argument) [optional]
+
 The Username/Organization for the destination repository, if different from `destination-github-username`. For the repository `https://github.com/cpina/push-to-another-repository-output` is `cpina`.
 
 ### `target-branch` (argument) [optional]
+
 The branch name for the destination repository. It defaults to `main`.
 
 ### `commit-message` (argument) [optional]
+
 The commit message to be used in the output repository. Optional and defaults to "Update from $REPOSITORY_URL@commit".
 
 The string `ORIGIN_COMMIT` is replaced by `$REPOSITORY_URL@commit`.
 
 ### `target-directory` (argument) [optional]
-The directory to wipe and replace in the target repository.  Defaults to wiping the entire repository
+
+The directory to wipe and replace in the target repository. Defaults to wiping the entire repository
+
+### `commit-tag` (argument) [optional]
+
+The name that you want to use to tag the current commit.
 
 ### `API_TOKEN_GITHUB` (environment)
+
 E.g.:
-  `API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}`
+`API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}`
 
 Generate your personal token following the steps:
-* Go to the Github Settings (on the right hand side on the profile picture)
+
-* On the left hand side pane click on "Developer Settings"
+- Go to the Github Settings (on the right hand side on the profile picture)
-* Click on "Personal Access Tokens" (also available at https://github.com/settings/tokens)
+- On the left hand side pane click on "Developer Settings"
-* Generate a new token, choose "Repo". Copy the token.
+- Click on "Personal Access Tokens" (also available at https://github.com/settings/tokens)
+- Generate a new token, choose "Repo". Copy the token.
 
 Then make the token available to the Github Action following the steps:
-* Go to the Github page for the repository that you push from, click on "Settings"
+
-* On the left hand side pane click on "Secrets"
+- Go to the Github page for the repository that you push from, click on "Settings"
-* Click on "Add a new secret" and name it "API_TOKEN_GITHUB"
+- On the left hand side pane click on "Secrets"
+- Click on "Add a new secret" and name it "API_TOKEN_GITHUB"
 
 ## Example usage
+
 ```yaml
-      - name: Pushes to another repository
+- name: Pushes to another repository
-        uses: cpina/github-action-push-to-another-repository@main
+  uses: cpina/github-action-push-to-another-repository@main
-        env:
+  env:
-          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
+    API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
-        with:
+  with:
-          source-directory: 'output'
+    source-directory: "output"
-          destination-github-username: 'cpina'
+    destination-github-username: "cpina"
-          destination-repository-name: 'pandoc-test-output'
+    destination-repository-name: "pandoc-test-output"
-          user-email: carles3@pina.cat
+    user-email: carles3@pina.cat
-          target-branch: main
+    target-branch: main
 ```
 
 Working example: