Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 33 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,48 @@
# Mergify CLI

## Introduction
Mergify CLI is a tool that automates the creation and management of stacked
pull requests on GitHub as well as handling CI results upload.

Mergify CLI is a powerful tool designed to simplify and automate the creation
and management of stacked pull requests on GitHub as well as handling CI
results upload.
## Features

### Stacks
### Stacked Pull Requests

Before diving into its functionalities, let's grasp the concept of stacked pull
requests and why they matter in the
Create and manage stacked pull requests to break down large changes into
smaller, reviewable pieces. Learn more in the
[documentation](https://docs.mergify.com/stacks/).

### CI
### CI Insights

You can learn more about [CI Insights in the
Upload and analyze CI results to get better visibility into your CI pipeline.
Learn more about [CI Insights in the
documentation](https://docs.mergify.com/ci-insights/).

## Installation

```shell
pip install mergify-cli
```

## Usage

```shell
# Show available commands
mergify --help

# Manage stacked pull requests
mergify stack --help

# Upload CI results
mergify ci --help
```

## Contributing

We welcome and appreciate contributions from the open-source community to make
this project better. Whether you're a developer, designer, tester, or just
someone with a good idea, we encourage you to get involved.

## License

This project is licensed under the Apache License 2.0 - see the
[LICENSE](LICENSE) file for details.
2 changes: 1 addition & 1 deletion mergify_cli/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/_globals.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/cli.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/stack/changes.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/stack/hooks/scripts/prepare-commit-msg.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This file is managed by mergify-cli and will be auto-upgraded.
# Do not modify - add custom logic to the wrapper file instead.
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/stack/push.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/stack/setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/tests/conftest.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/tests/stack/test_push.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/tests/test_utils.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/tests/utils.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion mergify_cli/utils.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright © 2021-2024 Mergify SAS
# Copyright © 2021-2026 Mergify SAS
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
Expand Down
23 changes: 21 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
[project]
name = "mergify_cli"
dynamic = ["version"]
description = "Mergify CLI is a tool that automates the creation and management of stacked pull requests on GitHub"
authors = [{ name = "Mehdi Abaakouk", email = "sileht@mergify.com" }]
description = "Mergify CLI is a tool that automates the creation and management of stacked pull requests on GitHub and handles CI results upload"
authors = [{ name = "Mergify Team", email = "hello@mergify.com" }]
requires-python = ">=3.13"
readme = "README.md"
license = "Apache-2.0"
keywords = ["git", "github", "pull-request", "stacked-pr", "ci", "merge"]
classifiers = [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3.14",
"Topic :: Software Development :: Version Control :: Git",
"Typing :: Typed",
]

dependencies = [
"httpx==0.28.1",
"rich==14.3.3",
Expand All @@ -22,6 +34,13 @@ dependencies = [
[project.scripts]
mergify = "mergify_cli.cli:main"

[project.urls]
Homepage = "https://mergify.com"
Documentation = "https://docs.mergify.com"
Repository = "https://github.com/Mergifyio/mergify-cli"
Issues = "https://github.com/Mergifyio/mergify-cli/issues"
Changelog = "https://github.com/Mergifyio/mergify-cli/releases"

[dependency-groups]
dev = [
"mypy==1.19.1",
Expand Down