Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/guillaumefalourd/create-other-repo-branch-action

Github Action to create a new branch on another repository 🆕🚀
https://github.com/guillaumefalourd/create-other-repo-branch-action

all-os-supported branch github-actions hacktoberfest remote-execution repository utilities

Last synced: 2 months ago
JSON representation

Github Action to create a new branch on another repository 🆕🚀

Awesome Lists containing this project

README

        

# Create Other Repo Branch Action

[![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DGuillaumeFalourd%2Fcreate-other-repo-branch-action%26badge%3Dtrue)](https://github.com/search?o=desc&q=GuillaumeFalourd+create-other-repo-branch-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code) [![Action test on Ubuntu](https://github.com/GuillaumeFalourd/create-other-repo-branch-action/actions/workflows/ubuntu_test_action.yml/badge.svg)](https://github.com/GuillaumeFalourd/create-other-repo-branch-action/actions/workflows/ubuntu_test_action.yml) [![Action test on MacOS](https://github.com/GuillaumeFalourd/create-other-repo-branch-action/actions/workflows/macos_test_action.yml/badge.svg)](https://github.com/GuillaumeFalourd/create-other-repo-branch-action/actions/workflows/macos_test_action.yml) [![Action test on Windows](https://github.com/GuillaumeFalourd/create-other-repo-branch-action/actions/workflows/windows_test_action.yml/badge.svg)](https://github.com/GuillaumeFalourd/create-other-repo-branch-action/actions/workflows/windows_test_action.yml)

![title](https://user-images.githubusercontent.com/22433243/124029399-7d608c80-d9cb-11eb-9f78-48524007ac3d.png)

Github Action to create a new branch on another repository 🆕🚀

* * *

## 📚 Usage

## ⚙️ How does the action work?

_⚠️ Don't use this action to create a branch on the same repository! To do so, [other actions on the marketplace are more efficient](https://github.com/marketplace?type=actions&query=create+branch+). You can also do it with the [actions/checkout](https://github.com/actions/checkout) and `git` commands._

### ♻️ Scenarios

#### Creating new branch on another repository using `default branch` as reference

```yaml
steps:
- uses: GuillaumeFalourd/[email protected]
with:
repository_owner: GuillaumeFalourd
repository_name: poc-github-actions
new_branch_name: release-1.2.3
access_token: ${{ secrets.ACCESS_TOKEN}}
```

#### Creating new branch on another repository using `a specific branch` as reference

```yaml
steps:
- uses: GuillaumeFalourd/[email protected]
with:
repository_owner: GuillaumeFalourd
repository_name: poc-github-actions
new_branch_name: release-1.2.3
new_branch_ref: release-candidate
access_token: ${{ secrets.ACCESS_TOKEN}}
```

* * *

## ▶️ Action Inputs

Field | Mandatory | Observation
------------ | ------------ | -------------
**repository_owner** | YES | Repository Owner
_e.g: `octocat`_
**repository_name** | YES | Repository Name
_e.g: `my-repo-name`_
**new_branch_name** | YES | New branch name created on other repository
_e.g: `release-*.*.*`_
**new_branch_ref** | NO | Reference to create the new branch name on other repository
_e.g: `release-candidate` (the `default branch` is used if not informed)_
**access_token** | NO | A [PAT](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) that has access to the repository (if necessary). Note: this should not be combined with `ssh_deploy_key`.
**ignore_branch_exists** | NO | This (boolean) field will gracefully skip branch creation if the requested branch already exists
_e.g: `true`_
**ssh_deploy_key** | NO | A [Deploy Key](https://docs.github.com/en/developers/overview/managing-deploy-keys) that has been configured to allow access from the source to destination repository. (if necessary) Note: this should not be combined with `access_token`.
**git_user_name** | NO | Specify the user.name to set in the git config
**git_user_email** | NO | Specify the user.email to set in the git config
* * *

## 🤝 Contributing

☞ [Guidelines](https://github.com/GuillaumeFalourd/create-other-repo-branch-action/blob/main/CONTRIBUTING.md)



(Made with [contributors-img](https://contrib.rocks))

## 🏅 Licensed

☞ This repository uses the [Apache License 2.0](https://github.com/GuillaumeFalourd/create-other-repo-branch-action/blob/main/LICENSE)