Skip to main content

Git submodule updater

Project description

PyPI version Build Status

gitsup

Gitsup allows automatic update of the Git submodules of a project to the latest commit. The intended purpose is to deploy the tool so execution can be triggered automatically by a Github webhook on update of the projects underlying the git submodules.

If the tool is executed, it will fetch the latest commit from the configured submodules and commit these changes to the parent repository. Git submodules that aren't configured, won't be updated.

This code is adapted from this stackoverflow post.

Quickstart

  • Installation: pip install gitsup
  • Create a parent project, e.g. tgamauf/gitsup-demo that contains two submodules tgamauf/gitsup-demo-submodule and jezen/is-thirteen (replace the owner of the first two with your own username)
  • Set the following environment variables
    • export GITSUP_OWNER=tgamauf
    • export GITSUP_REPOSITORY=gitsup-demo
    • export GITSUP_SUBMODULES=gitsup-demo-submodule
    • export GITSUP_SUBMODULE_gitsup-demo-submodule_OWNER=tgamauf
  • Update README.md in tgamauf/gitsup-demo-submodule
  • Execute gitsup --token <Github personal access token>

Gitsup will notify you that it updated tgamauf/gitsup-demo-submodule in tgamauf/gitsup-demo and you will see a new commit on tgamauf/gitsup-demo that indicates that the submodule has been updated. The tool will also let you know that the submodule is-thirteen hasn't been updated as it isn't configured.

The --token parameter is optional. If it isn't provided first the environment and subsequently a provided config file is checked for the token. A config file can be provided to Gitsup by parameter --config.

Please check the usage information for more info: gitsup --help

Configuration

Configuration of gitsub can be done either by environment variables or by a yaml/json configuration file. In both cases a Github personal access token, the parent repository and the submodules that should be auto-updated must be configured. The personal access token requires "repo" permissions for the parent project and all submodule projects in order to update the parent project. If the submodule projects are public repositories no specific permissions are required here. In any case write permissions for the parent repository must be granted.

The following global configuration options are available:

  • token: Github access token
  • owner: the owner of the parent repository
  • repository: the name of the parent repository
  • branch: the branch of the parent repository to update (optional; default: master)

For each submodule at least the repository has to be configured, for all other values sensible defaults are used if no value is supplied. The following configuration options exist per submodule:

  • repository: the name of the submodule repository
  • owner: the owner of the submodule repository (optional; default: owner of the parent project)
  • branch: the branch of the submodule repository to use (optional; default: master)
  • path: the path of the submodule in the parent repository (optional; default: repository name)

Environment Variables

  • GITSUP_TOKEN=<Github personal access token>
  • GITSUP_OWNER=<parent repository owner>
  • GITSUP_REPOSITORY=<parent repository name>
  • GITSUP_BRANCH=<parent repository branch>
  • GITSUP_SUBMODULES=<comma separated list of submodules>

The following environment variables can exist multiple times for any of the submodules defined by GITSUP_SUBMODULES:

  • GITSUP_SUBMODULE_<submodule>_OWNER=<submodule repository owner>
  • GITSUP_SUBMODULE_<submodule>_BRANCH=<submodule repository branch>
  • GITSUP_SUBMODULE_<submodule>_PATH=<submodule path in parent repository>

Minimal config:

  • GITSUP_TOKEN=<Github personal access token>
  • GITSUP_OWNER=<parent repository owner>
  • GITSUP_REPOSITORY=<parent repository name>
  • GITSUP_SUBMODULES=<single submodule>

YAML Config File

token: <Github personal access token>
owner: <parent repository owner>
repository: <parent repository name>
branch: <parent repository branch>

submodules:
  # One dict per submodule
  <submodule>:
      owner: <submodule repository owner>
      branch: <submodule repository branch>
      path: <submodule path in parent repository>

Minimal config:

token: <Github personal access token>
owner: <parent repository owner>
repository: <parent repository name>
submodules: <single submodule>

JSON Config File

{
  "token": "<Github personal access token>",
  "owner": "<parent repository owner>",
  "repository": <parent repository name>,
  "branch: <parent repository branch>
  "submodules": {
    "<submodule>: {
      "owner": "<submodule repository owner>",
      "branch": "<submodule repository branch>",
      "path": "<submodule path in parent repository>"
    }
  }
}

Minimal config:

{
  "token": "<Github personal access token>",
  "owner": "<parent repository owner>",
  "repository": <parent repository name>,
  "submodules": <single submodule>
}

Project details


Download files

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

Files for gitsup, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size gitsup-0.3.0-py3-none-any.whl (11.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page