Skip to main content

pull-request-codecommit creates a PR within CodeCommit based on your commit messages.

Project description

pull-request-codecommit

License Maintenance GitHub release Continuous Integration codecov

This tool makes it easy to create pull requests for AWS CodeCommit. It relies on the Conventional Commits standard. It looks at the git commits between the current and the destination branch. Then it tries to create a pull request with this information as input.

Installation

You can install the pull-request-codecommit tool by running the following command:

pip install pull-request-codecommit

You can update an existing installation with the following command:

pip install --upgrade pull-request-codecommit

Installation in venv

Typically, you would want to run your dependencies isolated. You can install [pull-request-codecommit][pull-request-codecommit] in a venv using the following commands:

python -m venv .venv
source .venv/bin/activate
pip install pull-request-codecommit

You need to add the .venv/bin/ path to your system PATH. This is needed for the git pr commands to function.

Configuration

The tool uses the following file ~/.aws/pull-request-codecommit. It will first load the default profile and then, if provided the profile specific settings.

[profile default]
branch=main

[profile acme-profile]
branch=develop

Usage

To use pull-request-codecommit you just execute the following command:

git pr

Auto merge

In some cases it makes sense to directly merge the pull request, in those cases you can use:

git pr --auto-merge

This will directly merge the pull request using the fast-forward merge strategy. If the merge is successful, it will:

  • Merge and close the pull request.
  • Checkout the destination branch.
  • Pull the latest changes. (This will pull the just merged changes locally)
  • Remove the working branch.

From this point you are ready for the next change.

Update existing pull request

When a pull requests exists a proposal is made to update the existing pull request.

Overwrite target branch

When you want to overwrite the target branch you need to supply the --branch <name> option:

git pr --branch my-target-branch

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pull_request_codecommit-0.5.15.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

pull_request_codecommit-0.5.15-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file pull_request_codecommit-0.5.15.tar.gz.

File metadata

File hashes

Hashes for pull_request_codecommit-0.5.15.tar.gz
Algorithm Hash digest
SHA256 64a37ad91e8caad27d3afbcb26e466b456d794c1c7fb1d322b1af68da3e990e1
MD5 709cf57fac1c93f4c1b78bd4bef08a32
BLAKE2b-256 e061f9b2390ddbde1048de8b6dd922cae322f65e8a356cee90222e4a73a8171e

See more details on using hashes here.

Provenance

File details

Details for the file pull_request_codecommit-0.5.15-py3-none-any.whl.

File metadata

File hashes

Hashes for pull_request_codecommit-0.5.15-py3-none-any.whl
Algorithm Hash digest
SHA256 a7d91ff367078f231a6407be9b6ca2b84c07439c8cf015cec763fc3c6963e759
MD5 46fabcc78f91a64d06fe3dfec15e1c2f
BLAKE2b-256 8363a3a4eb16d693a60be6c07ea6196073f2d167cb38a7cae0f76a2f9b05b5f2

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page