v0.1.5

.github/workflows/pr.yml

@@ -13,7 +13,8 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    name: Build and Test
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Clone repo
@@ -50,6 +51,47 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TKN }}
 
+  docker_amd64:
+    name: Build and Test for linux/amd64
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Clone repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # docs: https://github.com/marketplace/actions/build-and-push-docker-images
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      # docs: https://docs.docker.com/build/ci/github-actions/test-before-push/
+      - name: Build Docker image for linux/amd64
+        uses: docker/build-push-action@v6
+        with:
+          push: false
+          context: .
+          file: Dockerfile
+          platforms: linux/amd64
+          load: true
+          tags: ${{ github.repository }}:latest
+
+      - name: Run Docker tests for linux/amd64
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TKN }}
+        run: npm run docker:test
+
+  docker_arm64:
+    name: Build and Test for linux/arm64
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Clone repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
       # docs: https://github.com/marketplace/actions/build-and-push-docker-images
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -58,15 +100,17 @@ jobs:
         uses: docker/setup-buildx-action@v3
 
       # docs: https://docs.docker.com/build/ci/github-actions/test-before-push/
-      - name: Build Docker image
-        uses: docker/build-push-action@v5
+      - name: Build Docker image for linux/arm64
+        uses: docker/build-push-action@v6
         with:
           push: false
           context: .
+          file: Dockerfile
+          platforms: linux/arm64
           load: true
-          tags: github-commit-sign:latest
+          tags: ${{ github.repository }}:latest
 
-      - name: Run Docker tests
+      - name: Run Docker tests for linux/arm64
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TKN }}
         run: npm run docker:test

.github/workflows/release.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   publish:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     permissions:
       contents: read
       id-token: write
@@ -29,6 +29,31 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: linux/amd64,linux/arm64
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      -
+        name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          tags: ${{ github.repository }}:latest,${{ github.repository }}:${{ github.event.release.tag_name }}
+          context: .
+          file: Dockerfile
+          platforms: linux/amd64,linux/arm64
+
+      # publish to npm after docker image is built and pushed.
+      # this to avoid publishing to npm registry before a possible docker image build failure
       - name: Publish to npm
         run: npm publish --provenance --access public
         env:

README.md

@@ -1,8 +1,18 @@
 # GitHub Commit Sign
 
+[![GitHub release](https://img.shields.io/github/release/pirafrank/github-commit-sign.svg?style=flat-square)](https://github.com/pirafrank/github-commit-sign/releases/latest)
+[![GitHub marketplace](https://img.shields.io/badge/marketplace-github--commit--sign-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/github-commit-sign)
+[![Docker pulls](https://img.shields.io/docker/pulls/pirafrank/github-commit-sign.svg?style=flat-square)](https://hub.docker.com/r/pirafrank/github-commit-sign)
+[![npm](https://img.shields.io/npm/v/@pirafrank/github-commit-sign.svg?style=flat-square)](https://www.npmjs.com/package/@pirafrank/github-commit-sign)
+
 A thin wrapper to perform signed commits to a GitHub repository through their GraphQL APIs. Useful to create signed commits in CI/CD environments.
 
-Offered as node module and CLI tool.
+## Available as
+
+- [GitHub Action](https://github.com/marketplace/actions/github-commit-sign)
+- [Docker image](https://hub.docker.com/r/pirafrank/github-commit-sign)
+- [CLI tool](#cli-usage)
+- [npm module](https://www.npmjs.com/package/@pirafrank/github-commit-sign)
 
 ## Why
 
@@ -21,33 +31,107 @@ I have actually written this to get signed commits in GitHub Actions running [he
 
 ## ⚠️ Before you start
 
-- `GITHUB_TOKEN` must be set as environment variable. It must have write access to the repository you want to commit to
+### About `GITHUB_TOKEN`
+
+In GitHub Actions the `GITHUB_TOKEN` is [automatically generated](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) per each run and is available as an environment variable. For the commit action to work, the `GITHUB_TOKEN` must be set as environment variable and it must have *write* access to the repository you want to commit to.
+
+The following applies, based on the context you are running the action in:
+
+- **GitHub Actions**: If the repository is the same where your workflow run, you can either:
+  - Configure it by adding the following to your workflow YAML file (restricted priviledges, recommended):
+
+  ```yaml
+  permissions:
+    contents: write
+  ```
+
+  - Set it up for all workflows in your repository (wider priviledges, not recommended): Go to *Repository Settings > Actions > General > Workflow permissions*, and set `Read and write permissions`.
+
+- **GitHub Actions**: if you need to commit to other repositories, you may need to override the default `GITHUB_TOKEN` with a personal access token with the `repo` scope. Go to *Profile > Settings > Developer settings > Personal access tokens > Token (classic)*, and Generate new token (classic) with the full-control over `repo` scope.
+  - **Tip**: store the generated token in repository secrets!
+- **Docker image, npm module, or CLI**: when running outside of GitHub Actions, set an environment variable called `GITHUB_TOKEN` with the token value having full-control over `repo` scope.
+
+### Usage assumptions
+
 - Changed (or new) files must exist locally
   - for practial reasons, those files must have the same file name and file path as the ones in the repository you are replacing with your commit (or the same file name and file path you want them to have in the repository)
 - Deleted files may not exist locally, and their path may just be provided as argument
 - GraphQL APIs are not meant to be used to push a lot of code! If that is your case, please consider using a local clone and `git`.
 
-## Requirements
+## GitHub Action usage
+
+You can use this module as a GitHub Action. It is a Docker-based action.
+
+### Print help
+
+```yaml
+    # Print help
+    - name: Print help
+      uses: pirafrank/github-commit-sign@v0
+      with:
+        args: "--help"
+```
+
+### Commit changes
+
+Requirements when running in a GitHub Actions workflow:
+
+- `GITHUB_TOKEN` must be set as environment variable and it must have write access to the repository you want to commit to. Read the *Before you start* section above for more details.
+- `--changed` and `--deleted` may have multiple file paths, as a single string with space-separated values, or by repeating the option per each file path. All file paths must be relative to the repository root.
+
+```yaml
+    # Commit changes...
+    - name: Commit changes
+      id: commit_changes
+      uses: pirafrank/github-commit-sign@v0
+      if: ${{ vars.RUN_COMMIT_CHANGES == 'true' }}
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        args: "commit --owner=${{ github.repository_owner }} --repo=${{ github.event.repository.name }} --branch=${{ github.ref_name }} --commitMessage='this is a webflow signed commit' --changed new.txt dummy/subdir/changed.txt --deleted dummy/delete_me.txt another_deleted.txt"
+    # ...then use output details in another step
+    - name: Print git commit output
+      if: ${{ vars.RUN_COMMIT_CHANGES == 'true' }}
+      run: |
+        echo "Run command: ${{ steps.commit_changes.outputs.command }}"
+        echo "Commit URL: ${{ steps.commit_changes.outputs.commitUrl }}"
+
+```
+
+> [!TIP]
+> You may want to create string format list of added and changed files in a previous step in your workflow.
+
+### Other commands
+
+The action accepts the same commands you can provide to the CLI. Pass them as a single string to the `args` input. Read below for more details.
 
-- Node.js (18+)
+## Docker image
+
+You can use this module as a Docker image. It is a multi-arch image, so it should run on any architecture.
+
+The image is available on Docker Hub as `pirafrank/github-commit-sign`.
+
+The image run the CLI instance of the program, thus accepting the same commands you can provide to the CLI. Pass them as you'd do with any other Docker image.
+
+## CLI usage
+
+### Requirements
+
+- Node.js (18.18+)
 - A GitHub token with the `repo` scope.
   - The token must be set in the environment variable called `GITHUB_TOKEN`.
 
-Note: in GitHub Actions the `GITHUB_TOKEN` is automatically generated per each run and is available as an environment variable. More info [here](https://docs.github.com/en/actions/security-guides/automatic-token-authentication).
-
-## Installation
+### Installation
 
 ```sh
-npm install
+npm install -g @pirafrank/github-commit-sign
 ```
 
-## CLI
-
 ### Usage examples
 
 ```sh
 export GITHUB_TOKEN='your_github_token_here'
-node github.js commit \
+ggh commit \
   --owner yourname \
   --repo some_repo_of_yours \
   --branch main \
@@ -57,7 +141,7 @@ node github.js commit \
 
 ```sh
 export GITHUB_TOKEN='your_github_token_here'
-node github.js commit \
+ggh commit \
   --owner yourname \
   --repo some_repo_of_yours \
   --branch main \
@@ -71,7 +155,7 @@ Multi-file commit is also possible:
 
 ```sh
 export GITHUB_TOKEN='your_github_token_here'
-node github.js commit \
+ggh commit \
   --owner yourname \
   --repo some_repo_of_yours \
   --branch main \
@@ -105,54 +189,6 @@ init();
 
 Please refer to `index.js` for the function signatures.
 
-## GitHub Action usage
-
-You can use this module as a GitHub Action. It is a Docker-based action.
-
-### Print help
-
-```yaml
-    # Print help
-    - name: Print help
-      uses: pirafrank/github-commit-sign@v0
-      with:
-        args: "--help"
-```
-
-### Commit changes
-
-Requirements when running in a GitHub Actions workflow:
-
-- `--changed` and `--deleted` may have multiple file paths, as a single string with space-separated values, or by repeating the option per each file path. All file paths must be relative to the repository root.
-- `GITHUB_TOKEN` must be set in the environment variables with write access to the repository. Go to *Repository Settings > Actions > General > Workflow permissions*, and set `Read and write permissions`.
-
-To commit to other repositories, you may need to override the default `GITHUB_TOKEN` with a personal access token with the `repo` scope. Go to *Profile > Settings > Developer settings > Personal access tokens > Token (classic)*, and Generate new token (classic) with the full-control over `repo` scope. Tip: store the generated token in repository secrets.
-
-```yaml
-    # Commit changes...
-    - name: Commit changes
-      id: commit_changes
-      uses: pirafrank/github-commit-sign@v0
-      if: ${{ vars.RUN_COMMIT_CHANGES == 'true' }}
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        args: "commit --owner=${{ github.repository_owner }} --repo=${{ github.event.repository.name }} --branch=${{ github.ref_name }} --commitMessage='this is a webflow signed commit' --changed new.txt dummy/subdir/changed.txt --deleted dummy/delete_me.txt another_deleted.txt"
-    # ...then use output details in another step
-    - name: Print git commit output
-      if: ${{ vars.RUN_COMMIT_CHANGES == 'true' }}
-      run: |
-        echo "Run command: ${{ steps.commit_changes.outputs.command }}"
-        echo "Commit URL: ${{ steps.commit_changes.outputs.commitUrl }}"
-
-```
-
-Tip: you may create the strings with the list of added and changed files from a previous step in your workflow.
-
-### Other commands
-
-The action accepts the same commands you can provied to the CLI. Pass them as a single string to the `args` input.
-
 ## Tests
 
 Create a `.env` file with your `repo`-scoped `GITHUB_TOKEN`, then run:

github.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const fs = require("fs");
 const yargs = require("yargs");
 const CURRENT_VERSION = require("./package.json").version;
@@ -10,9 +12,8 @@ const {
   checkIfBranchExists,
 } = require("./index");
 
-
 const commitCommand = "commit";
-const branchCommand = "branch"
+const branchCommand = "branch";
 const knownCommands = [commitCommand, branchCommand];
 
 const appendLineToFile = (filename, line) => {
@@ -156,9 +157,7 @@ yargs
       checkIfBranchExists(owner, repo, branch)
         .then((response) => {
           const n = response ? "a" : "no";
-          info(
-            `Repository ${owner}/${repo} has ${n} branch named '${branch}'`
-          );
+          info(`Repository ${owner}/${repo} has ${n} branch named '${branch}'`);
           writeResultToGithubOutputFile([
             {
               label: "command",