https://github.com/ctux/simple-pull-request-gh-action

A GitHub action that automates pull requests creating.
https://github.com/ctux/simple-pull-request-gh-action

action actions github github-action github-actions pull-request

Last synced: about 2 months ago
JSON representation

A GitHub action that automates pull requests creating.

• Host: GitHub
• URL: https://github.com/ctux/simple-pull-request-gh-action
• Owner: cTux
• License: mit
• Created: 2022-05-26T13:29:18.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T21:02:59.000Z (about 2 years ago)
• Last Synced: 2024-04-13T21:54:52.405Z (about 2 years ago)
• Topics: action, actions, github, github-action, github-actions, pull-request
• Language: Shell
• Homepage:
• Size: 116 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Simple Pull Request GitHub Action

A GitHub action that automates creating pull requests. Just specify command to execute and this action will create a pull request if changes were detected.

### This action helps with:

* Auto-updating dependencies ([project](./packages/npm-dependencies), [action](./.github/workflows/npm-dependencies.yml)) [![Dependencies update](https://github.com/cTux/simple-pull-request-gh-action/actions/workflows/npm-dependencies.yml/badge.svg)](https://github.com/cTux/simple-pull-request-gh-action/actions/workflows/npm-dependencies.yml)

* Auto-fixing issues after dependencies audit ([project](./packages/npm-dependencies), [action](./.github/workflows/npm-dependencies-audit.yml)) [![Dependencies audit](https://github.com/cTux/simple-pull-request-gh-action/actions/workflows/npm-dependencies-audit.yml/badge.svg)](https://github.com/cTux/simple-pull-request-gh-action/actions/workflows/npm-dependencies-audit.yml)

* Auto-generating types

* Auto-fetching new localization

* Auto-updating public API data saved locally

## How to use?

```yaml

name: Automatic PR

on:

  schedule:

    - cron: '0/60 * * * *'

jobs:

  update-dependencies:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout the head commit of the branch

        uses: actions/checkout@v2

        with:

          persist-credentials: false

      - name: Run command

        uses: ctux/simple-pull-request-gh-action@1.0.2-rc

        with:

          token: ${{ secrets.GITHUB_TOKEN }}

          commit_message: "'add(app): new file'"

```

## Inputs

| Name             | Description                                    | Required | Default             |

|------------------|------------------------------------------------|----------|---------------------|

| token            | GITHUB_TOKEN or a Personal Access Token (PAT). | Yes      | N/A                 |

| branch_main_name | Base branch name.                              | No       | main                |

| branch_pr_name   | Changes branch name.                           | No       | simple-pr-changes   |

| commit_message   | Commit message for a pull request.             | No       | chore(app): changes |

## Notes:

* The committer name is set to the GitHub Actions bot user. GitHub 

## License

This tool is distributed under the terms of the MIT license. See [LICENSE](./LICENSE) for details.