Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/logerfo/gitflow-action
Automatically creates and merges pull requests from master to dev and from release to master.
https://github.com/logerfo/gitflow-action
actions gitflow
Last synced: 8 days ago
JSON representation
Automatically creates and merges pull requests from master to dev and from release to master.
- Host: GitHub
- URL: https://github.com/logerfo/gitflow-action
- Owner: Logerfo
- License: mit
- Created: 2019-10-18T14:31:40.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T22:46:00.000Z (14 days ago)
- Last Synced: 2024-12-18T19:53:25.267Z (9 days ago)
- Topics: actions, gitflow
- Language: JavaScript
- Homepage:
- Size: 366 KB
- Stars: 23
- Watchers: 3
- Forks: 15
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://david-dm.org/logerfo/gitflow-action?type=dev)
# Gitflow Action
This action will automatically merge your `master` branch into `dev` and `release` into `master` through the creation of pull requests that will be automatically merged, if possible and enabled.
Those pull requests will be identified by a label named `gitflow` as default.
## Setting up
Create a file named `.github/workflows/gitflow.yml`.
### Minimal configuration
```yml
name: Gitflow
on:
# To create pull requests.
push:
# To merge pull requests if not possible during the push run. Remove if `auto-merge` is `false`.
pull_request_review:
check_run:
types: [completed]
permissions:
contents: read
pull-requests: write
jobs:
build:
name: Gitflow
runs-on: ubuntu-16.04
steps:
- uses: Logerfo/[email protected]
with:
github-token: ${{ secrets.GITHUB_TOKEN }} # The `GITHUB_TOKEN` secret.
```
### Disabled auto merge
```yml
name: Gitflow
on:
# To create pull requests.
- push
permissions:
contents: read
pull-requests: write
jobs:
build:
name: Gitflow
runs-on: ubuntu-16.04
steps:
- uses: Logerfo/[email protected]
with:
github-token: ${{ secrets.GITHUB_TOKEN }} # The `GITHUB_TOKEN` secret.
auto-merge: false # If `true`, will try to automatically merge the pull requests.
```
### Complete configuration
All values are default.
```yml
name: Gitflow
on:
# To create pull requests.
push:
# To merge pull requests if not possible during the push run. Remove if `auto-merge` is `false`.
pull_request_review:
check_run:
types: [completed]
permissions:
contents: read
pull-requests: write
jobs:
build:
name: Gitflow
runs-on: ubuntu-16.04
steps:
- uses: Logerfo/[email protected]
with:
github-token: ${{ secrets.GITHUB_TOKEN }} # The `GITHUB_TOKEN` secret.
release: release # The `release` branch.
release-regex: ^release/(.*) # The regex for `release` branch.
dev: dev # The `dev` branch.
master: master # The `master` branch.
label: gitflow # The pull request label.
auto-merge: true # If `true`, will try to automatically merge pull requests. Can also be set to `pull_request_review`, `check_run`, `push`, or a comma-separated combination of these values to only merge when handling the named events.
require-merge: false # If an attempted merge fails, the action is considered to have failed.
```
### Auto update
You can use (at your own risk) the `release` branch instead of the specific version tag.
Never user `master`, since the distribution file does not exist in this branch and the action will always fail.
## Changelog
Click [here](CHANGELOG.md).
## Contributing
If you have suggestions for how close-label could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the [Contributing Guide](CONTRIBUTING.md).
## Donate
BTC: 1LoGErFoNzE1gCA5fzk6A82nV6iJdKssSZ