https://github.com/tyriis/multi-file-commit

GitHub Action to push more then one file via GitHub API with signed commits.
https://github.com/tyriis/multi-file-commit

action commit nodejs

Last synced: 4 days ago
JSON representation

GitHub Action to push more then one file via GitHub API with signed commits.

• Host: GitHub
• URL: https://github.com/tyriis/multi-file-commit
• Owner: tyriis
• License: mit
• Created: 2023-06-18T20:09:31.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-23T21:39:11.000Z (10 months ago)
• Last Synced: 2024-10-08T19:16:12.497Z (about 1 month ago)
• Topics: action, commit, nodejs
• Language: JavaScript
• Homepage: https://github.com/tyriis/multi-file-commit/blob/main/README.md
• Size: 1.65 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![pre-commit][pre-commit-shield]][pre-commit-url]

[![taskfile][taskfile-shield]][taskfile-url]

# Multi File Commit

This action commit multiple files over the GitHub API by pushing blobs and adding them to a tree. It commit all staged files.

  Table of Contents

- [User Story](#user-story)

- [The Idea](#the-idea)

- [Limitations](#limitations)

- [What's new](#whats-new)

- [Usage](#usage)

- [License](#license)

## User Story

As a user I want to push and commit multiple files in 1 commit. if doing it via git push, there is no way to sign the the commit in an action context.

Of course I want to use `only signed commits` restriction on my branches (and I dont want to bypass the restriction to protect my software supply chain).

## The Idea

It is possible to create blobs and tree to create a commit via GitHub API.

I found the solution to the problem here: 

Thanks for your work [Siddhartha Varma](https://github.com/BRO3886).

## Limitations

:warning: it cannot be used on empty repositories. \

:warning: parallel commits on the same file lead to a race condition where previous changes are overwritten.

## What's new

- First implementation is currently tested

## Usage

```yaml

- uses: tyriis/[email protected]

  with:

    # Repository name with owner. For example, actions/checkout

    # Default: ${{ github.repository }}

    repository: ''

    # The branch you want to push the commit

    # Default: ${{ github.ref_name }}

    ref: ''

    # Personal access token (PAT) used to fetch the repository. The PAT is configured

    # with the local git config, which enables your scripts to run GitHub API commands.

    # Default: ${{ github.token }}

    token: ''

    # The commit message for the commit.

    message: ''

    # A list of files to commit, prevent other staged files to be commited.

    # Example: src/main.mjs,src/main.spec.js

    # If not set all staged files are considered for commit.

    files: ''

    # In case you want to tag your commit, just pass a tag reference and this action will do the work for you.

    tag: ''

```

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE)

[pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&style=for-the-badge

[pre-commit-url]: https://github.com/pre-commit/pre-commit

[taskfile-url]: https://taskfile.dev/

[taskfile-shield]: https://img.shields.io/badge/Taskfile-Enabled-brightgreen?logoColor=white&style=for-the-badge