Skip to content

gisce/apply_pr

Repository files navigation

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 from GitHub.

To use you must generate an OAuth token from GitHub and set to the GITHUB_TOKEN environment variable.

Command line scripts

This repository uses the Click 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
check_prs Check the status of the PRs for a set of PRs Check pull requests status
status Update the status of a deploy into GitHub Mark deploy status
create_changelog Create a chnagelog for the given milestone Create Changelog
check_pr Deprecated: Check if the PR's commits are applied on the server Check Applied patches

Install

# Install from Pypi
pip install apply_pr

Usage

NOTE: do not include braces on the following commands

DEPLOY

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

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

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

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)

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.