Merge upstream

.github/workflows/build.yml

@@ -7,14 +7,14 @@ on:
 jobs:
 
   build:
- 
+
     runs-on: ubuntu-latest
- 
+
     steps:
-    - uses: actions/checkout@master
-    - name: Verify action syntax 
-      # The action should not publish any real changes, but should succeed.
-      uses: './'
-      with:
-        github_token: '${{ secrets.GITHUB_TOKEN }}'
-        branch: '${{ github.ref }}'
+      - uses: actions/checkout@v4
+      - name: Verify action syntax
+        # The action should not publish any real changes, but should succeed.
+        uses: './'
+        with:
+          github_token: '${{ secrets.GITHUB_TOKEN }}'
+          branch: '${{ github.ref }}'

.github/workflows/monitoring_link.yml

@@ -13,7 +13,7 @@ jobs:
     name: Validate links
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v4
     - name: Validate links
       uses: ad-m/report-link-action@master
       with:

.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Publish
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+
+  publish:
+    name: Publish the release version
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository and the branch
+        uses: actions/checkout@v4
+
+      - name: Setup the release version and overwrite the existing major version tag
+        run: |
+          major_version=$(echo $GITHUB_REF_NAME | cut -d. -f1)
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git tag -fa $major_version -m "Update $major_version tag and add version $GITHUB_REF_NAME to it"
+          git push origin $major_version --force

.gitignore

@@ -0,0 +1 @@
+/.idea/

action.yml

@@ -7,12 +7,15 @@ branding:
 inputs:
   github_token:
     description: 'GitHub token or PAT token'
-    required: true
+    required: false
     default: ${{ github.token }}
   github_url:
     description: 'GitHub url or GitHub Enterprise url'
-    required: true
+    required: false
     default: ${{ github.server_url }}
+  ssh:
+    description: 'Specify if ssh should be used'
+    required: false
   repository:
     description: 'Repository name to push. Default or empty value represents current github repository (${GITHUB_REPOSITORY})'
     default: ''
@@ -23,13 +26,26 @@ inputs:
   force:
     description: 'Determines if force push is used'
     required: false
+  force_with_lease:
+    description: 'Determines if force-with-lease push is used'
+    required: false
+  atomic:
+    description: 'Determines if atomic push is used, default true'
+    required: false
+  push_to_submodules:
+    description: 'Determines if --recurse-submodules=<strategy> is used. The value defines the used strategy'
+    required: false
+    default: 'on-demand'
   tags:
     description: 'Determines if --tags is used'
     required: false
+  push_only_tags:
+    description: 'Determines if the action should only push the tags, default false'
+    required: false
   directory:
     description: 'Directory to change to before pushing.'
     required: false
     default: '.'
 runs:
-  using: 'node12'
+  using: 'node20'
   main: 'start.js'

docs/personal-acces-token.md

@@ -0,0 +1,10 @@
+# Creation of a personal access token
+
+1. Login to your GitHub account and navigate to the following [page](https://github.com/settings/tokens).
+2. Click on the generate new token button and start the process to get a new token (classic or fine-gained)
+   - In the classic mode your token needs as a minimum requirement for private repositories, complete repo and admin read:org access. ![PAT Private Repo](images/Github_PAT_Private_Repo.jpeg)
+
+   - In the classic mode and you want to use it on public repositories, your token needs public_repo access. ![PAT Public Repo](images/Github_PAT_Public_Repo.jpeg)
+
+   - If you want to use a fine-gained token as minimum requirement, your token needs access to the repository, contents read/write, metadata read and actions read access. ![PAT Fine Gained](images/Github_PAT_Fine_Gained.jpeg)
+3. Be aware, if you want to update GitHub workflow files, it's necessary that your token got workflow rights (read/write on fine-gained tokens).

start.js

@@ -1,9 +1,10 @@
 'use strict';
 const spawn = require('child_process').spawn;
-const path = require("path");
+const path = require('path');
+const http = require('http');
 const https = require('https');
 
-const get = (url, options = {}) => new Promise((resolve, reject) => https
+const get = (url, options = {}) => new Promise((resolve, reject) => ((new URL(url).protocol === 'http:') ? http : https)
     .get(url, options, (res) => {
         const chunks = [];
         res.on('data', (chunk) => chunks.push(chunk));
@@ -42,8 +43,8 @@ const trim = (value, charlist) => trimLeft(trimRight(value, charlist));
 const main = async () => {
     let branch = process.env.INPUT_BRANCH;
     const repository = trim(process.env.INPUT_REPOSITORY || process.env.GITHUB_REPOSITORY);
-    const github_url_protocol = trim(process.env.INPUT_GITHUB_URL).split("//")[0];
-    const github_url = trim(process.env.INPUT_GITHUB_URL).split("//")[1];
+    const github_url_protocol = trim(process.env.INPUT_GITHUB_URL).split('//')[0];
+    const github_url = trim(process.env.INPUT_GITHUB_URL).split('//')[1];
     if (!branch) {
         const headers = {
             'User-Agent': 'github.com/ad-m/github-push-action'
@@ -65,6 +66,5 @@ const main = async () => {
 
 main().catch(err => {
     console.error(err);
-    console.error(err.stack);
-    process.exit(err.code || -1);
+    process.exit(-1);
 })

start.sh

@@ -1,29 +1,65 @@
 #!/bin/sh
 set -e
 
+INPUT_ATOMIC=${INPUT_ATOMIC:-true}
 INPUT_FORCE=${INPUT_FORCE:-false}
+INPUT_FORCE_WITH_LEASE=${INPUT_FORCE_WITH_LEASE:-false}
+INPUT_SSH=${INPUT_SSH:-false}
 INPUT_TAGS=${INPUT_TAGS:-false}
-INPUT_DIRECTORY=${INPUT_DIRECTORY:-'.'}
-_FORCE_OPTION=''
+INPUT_PUSH_ONLY_TAGS=${INPUT_PUSH_ONLY_TAGS:-false}
+INPUT_DIRECTORY=${INPUT_DIRECTORY:-"."}
+INPUT_PUSH_TO_SUBMODULES=${INPUT_PUSH_TO_SUBMODULES:-""}
+_ATOMIC_OPTION=""
+_FORCE_OPTION=""
 REPOSITORY=${INPUT_REPOSITORY:-$GITHUB_REPOSITORY}
 
 echo "Push to branch $INPUT_BRANCH";
 [ -z "${INPUT_GITHUB_TOKEN}" ] && {
-    echo 'Missing input "github_token: ${{ secrets.GITHUB_TOKEN }}".';
+    echo "Missing input 'github_token: ${{ secrets.GITHUB_TOKEN }}'.";
     exit 1;
 };
 
+if ${INPUT_FORCE} && ${INPUT_FORCE_WITH_LEASE}; then
+  echo "Please, specify only force or force_with_lease and not both.";
+  exit 1;
+fi
+
+if ${INPUT_ATOMIC}; then
+    _ATOMIC_OPTION="--atomic"
+fi
+
 if ${INPUT_FORCE}; then
-    _FORCE_OPTION='--force'
+    _FORCE_OPTION="--force"
+fi
+
+if ${INPUT_FORCE_WITH_LEASE}; then
+    _FORCE_OPTION="--force-with-lease"
 fi
 
 if ${INPUT_TAGS}; then
-    _TAGS='--tags'
+    _TAGS="--tags"
+fi
+
+if [ -n "${INPUT_PUSH_TO_SUBMODULES}" ]; then
+  _INPUT_PUSH_TO_SUBMODULES="--recurse-submodules=${INPUT_PUSH_TO_SUBMODULES}"
 fi
 
 cd ${INPUT_DIRECTORY}
 
-remote_repo="${INPUT_GITHUB_URL_PROTOCOL}//${GITHUB_ACTOR}:${INPUT_GITHUB_TOKEN}@${INPUT_GITHUB_URL}/${REPOSITORY}.git"
-git config --local --add safe.directory ${INPUT_DIRECTORY}
+if ${INPUT_SSH}; then
+    remote_repo="git@${INPUT_GITHUB_URL}:${REPOSITORY}.git"
+else
+    remote_repo="${INPUT_GITHUB_URL_PROTOCOL}//oauth2:${INPUT_GITHUB_TOKEN}@${INPUT_GITHUB_URL}/${REPOSITORY}.git"
+fi
+
+if ! ${INPUT_FORCE_WITH_LEASE}; then
+  ADDITIONAL_PARAMETERS="${remote_repo} HEAD:${INPUT_BRANCH}"
+elif ${INPUT_PUSH_ONLY_TAGS}; then
+  ADDITIONAL_PARAMETERS="${remote_repo}"
+fi
+
+if ${INPUT_FORCE_WITH_LEASE} && ${INPUT_TAGS}; then
+  _ATOMIC_OPTION=""
+fi
 
-git push "${remote_repo}" HEAD:${INPUT_BRANCH} --follow-tags $_FORCE_OPTION $_TAGS;
+git push $ADDITIONAL_PARAMETERS $_INPUT_PUSH_TO_SUBMODULES $_ATOMIC_OPTION --follow-tags $_FORCE_OPTION $_TAGS;