Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gisce/apply_pr
Fabric tools to apply pull requests on production
https://github.com/gisce/apply_pr
deployment fabric github hacktoberfest pull-requests
Last synced: 3 months ago
JSON representation
Fabric tools to apply pull requests on production
- Host: GitHub
- URL: https://github.com/gisce/apply_pr
- Owner: gisce
- License: mit
- Created: 2014-09-18T16:32:25.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-19T05:43:31.000Z (7 months ago)
- Last Synced: 2024-09-20T03:08:22.771Z (4 months ago)
- Topics: deployment, fabric, github, hacktoberfest, pull-requests
- Language: Python
- Homepage:
- Size: 298 KB
- Stars: 4
- Watchers: 18
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Apply pull requests
Fabric tools to apply pull requests in servers using `git format-patch` and
`git am`.
Is integrated with the new [deployment
API](https://developer.github.com/v3/repos/deployments/) from GitHub.
To use you must [generate an OAuth token](https://github.com/settings/tokens/new)
from GitHub and set to the `GITHUB_TOKEN` environment variable.
## Command line scripts
This repository uses the [Click](http://click.pocoo.org/5/) package to
register commands that call the fabric scripts.
The following commands are supported with `sastre`:
| Console Command | Description | Wiki page |
|:---------------: |:--------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------|
| `deploy` | Apply a PR to a remote server | [Deploy a pull request](https://github.com/gisce/apply_pr/wiki/Apply-a-Pull-Request) |
| `check_prs` | Check the status of the PRs for a set of PRs | [Check pull requests status](https://github.com/gisce/apply_pr/wiki/Check-pull-requests-status) |
| `status` | Update the status of a deploy into GitHub | [Mark deploy status](https://github.com/gisce/apply_pr/wiki/Mark-deploy-status) |
| `create_changelog` | Create a chnagelog for the given milestone | [Create Changelog](https://github.com/gisce/apply_pr/wiki/Create-Changelog) |
| `check_pr` | **Deprecated:** Check if the PR's commits are applied on the server | [Check Applied patches](https://github.com/gisce/apply_pr/wiki/Check-applied-patches-(deprecated)) |
## Install
```bash
# Install from Pypi
pip install apply_pr
```
## Usage
**NOTE**: do not include braces on the following commands
### DEPLOY
```bash
Usage: deploy [OPTIONS]
Options:
--pr TEXT Pull request to deploy [required]
--host TEXT Host to where to be deployed [required]
--from-number INTEGER From commit number
--from-commit TEXT From commit hash (included)
--force-hostname TEXT Force hostname [default: False]
--owner TEXT GitHub owner name [default: gisce]
--repository TEXT GitHub repository name [default: erp]
--src TEXT Remote src path [default: /home/erp/src]
--help Show this message and exit.
```
### STATUS
```bash
Usage: status [OPTIONS]
Options:
--deploy-id TEXT Deploy id to mark
--status [success|error|failure]
Status to set [default: success]
--owner TEXT GitHub owner name [default: gisce]
--repository TEXT GitHub repository name [default: erp]
--help Show this message and exit.
```
### CHECK PRS
```bash
Usage: check_prs [OPTIONS]
Options:
--prs TEXT List of pull request separated by space (by default)
[required]
--separator TEXT Character separator of list by default is space
[default: ; required]
--owner TEXT GitHub owner name [default: gisce]
--repository TEXT GitHub repository name [default: erp]
--help Show this message and exit.
```
### CREATE CHANGELOG
```bash
Usage: create_changelog [OPTIONS]
Options:
-m, --milestone TEXT Milestone to get the issues from (version)
[required]
--issues / --no-issues Also get the data on the issues [default: False]
--changelog_path TEXT Path to drop the changelog file in [default: /tmp]
--owner TEXT GitHub owner name [default: gisce]
--repository TEXT GitHub repository name [default: erp]
--help Show this message and exit.
```
### CHECK PR (deprecated)
```bash
Usage: check_pr [OPTIONS]
Options:
--pr TEXT Pull request to check [required]
--host TEXT Host to check [required]
--owner TEXT GitHub owner name [default: gisce]
--repository TEXT GitHub repository name [default: erp]
--src TEXT Remote src path [default: /home/erp/src]
--help Show this message and exit.
```