Skip to main content

Create and enforce standard rules on GitHub repositories managed by flox.

Project description

GitHub integration for flox

flox automation for GitHub repository managmenet

Exposed variables

  • github_clone_url - http checkout URL
  • github_url - public URL of the repository
  • github_ssh_url - checkout URL used for git+ssh protocol
  • github_repository - repository object as fetched from GitHub API
  • github_empty - True/False flag
  • git_repository - authenticated URL which can be used for all write operations

Installation

$ flox plugin install flox-github

or

$ pip install flox-github

Configuration

$ flox config --plugin github --scope=user

ℹ Starting configuration of github for 'user' scope
  GitHub default organization [getflox]:
  Default branch [develop]:
  Enable vulnerability alerts [Y/n]:
  Enable automated security fixes [Y/n]:
ℹ 'List of protected branches' configuration is accepting multiple values, each in new line, enter empty value to end input, '-' to delete value
  List of protected branches [master]:
  Create repository as private [Y/n]:
  Enable projects [Y/n]:
  Enable issue management [Y/n]:
  Enable wiki [Y/n]:
ℹ 'Collaborators with "pull" permission' configuration is accepting multiple values, each in new line, enter empty value to end input, '-' to delete value
ℹ 'Collaborators with "push" permission' configuration is accepting multiple values, each in new line, enter empty value to end input, '-' to delete value
ℹ 'Collaborators with "admin" permission' configuration is accepting multiple values, each in new line, enter empty value to end input, '-' to delete value

New configuration:

 Key                                    Old value  New value
─────────────────────────────────────────────────────────────
 Collaborators with "pull" permission   {}         -
 Collaborators with "push" permission   {}         -
 Collaborators with "admin" permission  {}         -

Save plugin settings? [y/N]: y
ℹ Configuration saved: /Users/user/.flox/settings.toml
  GitHub Access Token [xxx]: ------
 
New configuration:

 Key                  Old value                                  New value
──────────────────────────────────────────────────────────────────────────────────────────────────────────
 GitHub Access Token  -----                                      --------

Save plugin settings? [y/N]: y
ℹ Updated 1 secrets

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

flox-github-0.2.1.tar.gz (6.1 kB view hashes)

Uploaded Source

Built Distribution

flox_github-0.2.1-py3-none-any.whl (7.8 kB view hashes)

Uploaded Python 3

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