Skip to content

Python package that automates deployment of files to multiple github repositories at once

License

Notifications You must be signed in to change notification settings

tj-python/github-deploy

Repository files navigation

PyPI versionUpload Python PackageDownloads

github-deploy

Using polyrepo's to manage projects ?

This can introduce a number challenges one of which is maintaining consistency across multiple repositories, for files like shared configurations without introducing git submodules or mono repositories which requires a more complex deployment configuration.

For example adding a github action or maintaing a consistent pull request template accross your organization.

Solution

github-deploy makes maintaining such configurations as easy as a single command.

Alias : gh-deploy

Installation

pip install github-deploy

Usage

Creating or Updating files on github

gh-deploy update --org [org] --token [PAT_TOKEN] --dest [LOCATION TO UPLOAD FILE] --source [SOURCE FILE LOCATION]

Example:

gh-deploy update --org tj-actions --token [PAT_TOKEN] --dest '.github/workflows/auto-approve.yml' --source auto-approve.yml

NOTE: auto-approve.yml is located on your local system.

Deleting files on github

gh-deploy delete --org [org] --token [PAT_TOKEN] --dest [LOCATION TO DELETE]

Example:

gh-deploy delete --org tj-actions --token [PAT_TOKEN] --dest '.github/auto-approve.yml'

COMMAND

gh-deploy --help

Usage: gh-deploy [OPTIONS] COMMAND [ARGS]... Deploy changes to multiple github repositories using a single command. Options: --help Show this message and exit. Commands: delete Delete a file in all repositories owned by an organization/user. upload Upload a file to all repositories owned by an organization/user. 

gh-deploy upload --help

Usage: gh-deploy upload [OPTIONS] Upload a file to all repositories owned by an organization/user. Options: --org TEXT The github organization. --token TEXT Personal Access token with read and write access to org. --source PATH Source file. --dest TEXT Destination path. --overwrite / --no-overwrite Overwrite existing files. --private / --no-private Upload files to private repositories. --help Show this message and exit. 

gh-deploy delete --help

Usage: gh-deploy delete [OPTIONS] Delete a file in all repositories owned by an organization/user. Options: --org TEXT The github organization. --token TEXT Personal Access token with read and write access to org. --dest TEXT Destination path to delete. --help Show this message and exit. 

Resources

About

Python package that automates deployment of files to multiple github repositories at once

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5