{"id":13532750,"url":"https://github.com/maxkomarychev/merge-pal-action","last_synced_at":"2025-03-22T05:31:37.020Z","repository":{"id":36190890,"uuid":"218374054","full_name":"maxkomarychev/merge-pal-action","owner":"maxkomarychev","description":"GitHub Action that automatically merges your pull request!","archived":false,"fork":false,"pushed_at":"2023-01-04T23:42:48.000Z","size":354,"stargazers_count":32,"open_issues_count":16,"forks_count":11,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-13T15:41:54.454Z","etag":null,"topics":["github","github-action","github-actions","merge","workflow"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxkomarychev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-29T20:07:38.000Z","updated_at":"2023-10-26T00:49:38.000Z","dependencies_parsed_at":"2023-01-16T23:17:11.699Z","dependency_job_id":null,"html_url":"https://github.com/maxkomarychev/merge-pal-action","commit_stats":{"total_commits":23,"total_committers":1,"mean_commits":23.0,"dds":0.0,"last_synced_commit":"7a3bca37e260865d9e9a259212c1d13ef4da7f41"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxkomarychev%2Fmerge-pal-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxkomarychev%2Fmerge-pal-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxkomarychev%2Fmerge-pal-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxkomarychev%2Fmerge-pal-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxkomarychev","download_url":"https://codeload.github.com/maxkomarychev/merge-pal-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244912800,"owners_count":20530764,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","github-action","github-actions","merge","workflow"],"created_at":"2024-08-01T07:01:13.476Z","updated_at":"2025-03-22T05:31:35.257Z","avatar_url":"https://github.com/maxkomarychev.png","language":"JavaScript","funding_links":[],"categories":["Community Resources","JavaScript"],"sub_categories":["Pull Requests"],"readme":"# Merge Pal\n\nThis action will help your prs to get merged!\n\n# Contents\n\n- [Features](#features)\n- [Usage](#usage)\n  - [Note about tokens](#note-about-tokens)\n  - [Quick start](#quick-start)\n  - [Configuration](#configuration)\n\n# Features\n\n- relises on mergability rules defined in your repository\n- automatically updates your PR to be up to date with base branch\n- supports white and black lists through labels\n- supports various types of merge: normal, squash and rebase\n- integrates seamlessly into GitHub Actions workflows as well as other 3rdparty checks\n\n# Usage\n\n## Note about tokens\n\nDue to existing restriction workflows can not trigger each other if they are \nauthorized with `secrets.GITHUB_TOKEN`. For instance if you are using workflows that runs when code is pushed to master it will not be triggered if `secrets.GITHUB_TOKEN` is used to authorize Merge Pal. In such a scenarion you have to create [personal access token](https://github.com/settings/tokens) and use it instead.\n\n```yml\n  - uses: maxkomarychev/merge-pal-action@vX.Y.Z\n    with:\n      token: ${{ secrets.MY_USER_TOKEN }}\n```\n\n## Quick Start\n\n1. Specify desired mergeability rules in branch settings in your repository\n\n2. Create workflow to handle various events that affect mergeability of PR (`.github/workflows/merge-pal-events.yml`):\n\n    ```yml\n    name: Merge Pal (events)\n\n    on:\n      push: {} # update PR when base branch is updated\n      status: {} # try to merge when other checks are completed\n      pull_request_review: # try to merge after review\n        types:\n          - submitted\n          - edited\n          - dismissed\n      pull_request: # try to merge if labels have changed (white/black list)\n        types:\n          - labeled\n          - unlabeled\n\n    jobs:\n      # thats's all. single step is needed - if PR is mergeable according to\n      # branch protection rules it will be merged automatically\n      mergepal:\n        runs-on: ubuntu-latest\n        steps:\n          - uses: actions/checkout@v1\n          - uses: maxkomarychev/merge-pal-action@vX.Y.Z\n            with:\n              token: ${{ secrets.GITHUB_TOKEN }}\n\n    ```\n\n3. Add Merge Pal to the end of your existing check (if any) with GitHub Actions\n\n\n    ```yml\n    name: Merge Pal (PR)\n\n    on:\n      pull_request:\n        types:\n          - synchronize\n          - opened\n\n    jobs:\n      test-this: # test one things\n        runs-on: ubuntu-latest\n        steps:\n          - run: echo \"All ok\"\n      test-that: # test other things\n        runs-on: ubuntu-latest\n        steps:\n          - run: echo \"All ok\"\n      mergepal-merge: # run merge pal in the end\n        runs-on: ubuntu-latest\n        needs:\n          # make sure all required jobs are listed here\n          - test1-this\n          - test1-that\n        steps:\n          - uses: actions/checkout@v1\n          - uses: maxkomarychev/merge-pal-action@vX.Y.Z\n            with:\n              token: ${{ secrets.GITHUB_TOKEN }}\n\n    ```\n\n\n## Configuration\n\nVarious aspects of Merge Pal's behavior are configured thorugh configuration file.\n\nCreate file `.mergepal.yml` in root folder of your repo.\nIt can hold the following fields:\n\n| field | type | description |\n| --- | --- | --- |\n| whitelist | string[] | whitelisted labels to perform automerge |\n| blacklist | string[] | blacklisted labels to forbid automerge |\n| method | \"merge\" \\| \"squash\" \\| \"rebase\" | method to use when merging |\n\nexample:\n\n```yml\nwhitelist:\n  - good-to-merge\nblacklist:\n  - wip\n  - do-not-merge\nmethod: squash\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxkomarychev%2Fmerge-pal-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxkomarychev%2Fmerge-pal-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxkomarychev%2Fmerge-pal-action/lists"}