Skip to content
This repository has been archived by the owner on Oct 15, 2020. It is now read-only.

Latest commit

 

History

History
64 lines (47 loc) · 2.79 KB

README.md

File metadata and controls

64 lines (47 loc) · 2.79 KB

Autocommit

Summary Badge
Release Stability Autobadger Release Stability
Latest Release Autobadger Latest Release
Code Quality Maintainability
Code Coverage Test Coverage

Deprecated

Don't use this repo. Use this one instead (stefanzweifel/git-auto-commit-action).

Introduction

GitHub Action that automatically adds some files and commits them in preparation of a push to a remote. This Action is designed for use with an Action such as github-push-action as the following step.

Usage

Add this to your main.yml file (or whatever your workflow is called).

name: my-workflow

on: [push]

jobs:
  autocommit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      # Do something here, pre-stage.
      - uses: autosuite/autocommit@master
        with:
          commit-message: Your custom commit message here.
          add-options: -A
      - uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

Configuration

You can see all configuration in the action.yml file.

Variable Value Example Default Required?
add-options A string. -A -A Yes.
commit-message A string. Here's a message. See action.yml. Yes.
email A string. my@email.com noreply@github.com Yes.
name A string. Some Person GitHub Action Yes.

Documentation

If you would like to contribute to this project, please read our contributors documentation and our code of conduct.

The license we use for this project is defined in the license file.