Skip to content

A github action to automatically create PRs from a fork to the upstream

License

Notifications You must be signed in to change notification settings

UKnowWhoIm/auto-pr-fork

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Auto PR Fork

A github action to automatically create PR from a fork to the upstream

Table of Contents

Usage

steps:
  - uses: uknowwhoim/[email protected]
    with:
      # Title of your PR
      title: "Catch Up PR"
    env:
      GITHUB_TOKEN: ${{ secrets.AUTH_TOKEN }}

Inputs

GITHUB_TOKEN

The authentication token of user creating the PR. This user must have write access to the fork. How to create a token?

This parameter must be passed to the environment and must be stored as a repository secret.

- uses: uknowwhoim/auto-pr-fork@main
  env:
    GITHUB_TOKEN: ${{ secrets.AUTH_TOKEN }}

branch-fork

The branch of the fork you want to merge into upstream.

Default is main

branch-upstream

The branch of the upstream, you want to to merge your fork into.

Default is main

make-pr-draft

Make the PRs created by this repo draft by default(Public repos only)

Default is false

title

The title of PRs created by this action.

Default is Catch up with <OWNER>/<REPO_NAME>

description

The description of PRs created by this action.

Triggers

Push

Create a pull request on push.

# Triggers on all branches
on: push

# Triggers on main branch push only
on: 
  push:
    branches:
      - main

Schedule

Schedule a pull request in a period of time repeatedly. Visit crontab guru to generate cron syntax.

on:
  schedule:
    # At 00:00 on every 3rd day-of-month
    - cron: '0 0 */3 * *'

About

A github action to automatically create PRs from a fork to the upstream

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published