Merge pull request #20 from devops-infra/feature/git-push-force

Enable `git push --force`

Author: ChristophShyper

README.md

@@ -10,6 +10,7 @@ Features:
 * Can add a timestamp to a branch name, when `target_branch` is set and `add_timestamp` is `true`. Will create a branch named `${branch_name}/${add_timestamp}`. Great for cron-based updates.
 * As a commit message will use `commit_message` if set, or `commit_prefix` and add changed files or just list changed files.
 * Good to combine with my other action [devops-infra/action-pull-request](https://github.com/devops-infra/action-pull-request).
+* Can use `git push --force` for fast-forward changes.
 
 
 ## Badge swag
@@ -41,22 +42,24 @@ Features:
         add_timestamp: true
         commit_prefix: "[AUTO]"
         commit_message: "Automatic commit"
+        force: false
         target_branch: update/version
 ```
 
 
-Input Variable | Required | Default |Description
-:--- | :---: | :---: | :---
-github_token | Yes | `""` | Personal Access Token for GitHub for pushing the code.
-add_timestamp | No | `false` | Whether to add the timestamp to a new branch name. Used when `target_branch` is set. Uses format `%Y-%m-%dT%H-%M-%SZ`.
-commit_prefix | No | `[AUTO-COMMIT]` | Prefix added to commit message.
-commit_message | No | `""` | Full commit message to set.
-target_branch | No | *current branch* | Name of a new branch to push the code into. Creates branch if not existing.
+| Input Variable | Required | Default          | Description                                                                                                            |
+| -------------- | -------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| github_token   | Yes      | `""`             | Personal Access Token for GitHub for pushing the code.                                                                 |
+| add_timestamp  | No       | `false`          | Whether to add the timestamp to a new branch name. Used when `target_branch` is set. Uses format `%Y-%m-%dT%H-%M-%SZ`. |
+| commit_prefix  | No       | `[AUTO-COMMIT]`  | Prefix added to commit message.                                                                                        |
+| commit_message | No       | `""`             | Full commit message to set.                                                                                            |
+| force          | No       | `false`          | Whether to use force push for fast-forward changes. Use only if necessary.                                             |
+| target_branch  | No       | *current branch* | Name of a new branch to push the code into. Creates branch if not existing.                                            |
 
-Outputs | Description
-:--- | :---
-files_changed | List of changed files. As returned by `git diff --staged --name-status`.
-branch_name | Name of the branch code was pushed into.
+| Outputs       | Description                                                              |
+| ------------- | ------------------------------------------------------------------------ |
+| files_changed | List of changed files. As returned by `git diff --staged --name-status`. |
+| branch_name   | Name of the branch code was pushed into.                                 |
 
 
 ## Examples

action.yml

@@ -18,6 +18,10 @@ inputs:
     description: Full commit message to set
     required: false
     default: ""
+  force:
+    description: Whether to force push
+    required: false
+    default: "false"
   target_branch:
     description: Name of a new branch to push the code into
     required: false

entrypoint.sh

@@ -10,6 +10,7 @@ echo "  commit_prefix:  ${INPUT_COMMIT_PREFIX}"
 echo "  commit_message: ${INPUT_COMMIT_MESSAGE}"
 echo "  target_branch:  ${INPUT_TARGET_BRANCH}"
 echo "  add_timestamp:  ${INPUT_ADD_TIMESTAMP}"
+echo "  force:          ${INPUT_FORCE}"
 
 # Require github_token
 if [[ -z "${GITHUB_TOKEN}" ]]; then
@@ -45,12 +46,14 @@ if [[ (-n "${INPUT_TARGET_BRANCH}" || "${INPUT_ADD_TIMESTAMP}" == "true") && -n
   git checkout -b "${BRANCH}"
 fi
 
+# Set git credentials
+git remote set-url origin "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}"
+git config --global user.name "${GITHUB_ACTOR}"
+git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+
 # Create an auto commit
 if [[ -n ${FILES_CHANGED} ]]; then
-  echo "[INFO] Committing and pushing changes."
-  git remote set-url origin "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}"
-  git config --global user.name "${GITHUB_ACTOR}"
-  git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+  echo "[INFO] Committing changes."
   git add -A
   if [[ -n "${INPUT_COMMIT_MESSAGE}" ]]; then
     git commit -am "${INPUT_COMMIT_MESSAGE}" --allow-empty
@@ -59,6 +62,19 @@ if [[ -n ${FILES_CHANGED} ]]; then
   else
     git commit -am "Files changed:" -m "${FILES_CHANGED}" --allow-empty
   fi
+  if [[ "${INPUT_FORCE}" == "true" ]]; then
+    git push origin "${BRANCH}" --force
+  else
+    git push origin "${BRANCH}"
+  fi
+fi
+
+# Push
+if [[ "${INPUT_FORCE}" == "true" ]]; then
+  echo "[INFO] Pushing changes."
+  git push origin "${BRANCH}" --force
+elif [[ -n ${FILES_CHANGED} ]]; then
+  echo "[INFO] Pushing changes."
   git push origin "${BRANCH}"
 fi