Skip to main content

Library for automation updates on multiple repositories.

Project description

Multi repo automation

Configuration

To be able to apply your changes on multiple repository you should create a file with something like this:

- dir: /home/user/src/my-repo
  name: user/my-repo
  types: ['javascript', 'python', 'docker']
  master_branch: master
  stabilization_branches: [1.0, 1.1]
  folders_to_clean: []

The main configuration is a YAML file ~/.config/multi-repo-automation.yaml with the following options:

repos_filename: the filename of the files with the repositories definitions create above, default is repos.yaml. browser: the browser to use to open the pull requests, default is xdg-open. editor: the editor to use to edit files, default is xdg-open.

Migration script base

#!/usr/bin/env python3

import multi_repo_automation as mra

def _do() -> None:
    # Your actions

if __name__ == "__main__":
    mra.main(
        _do,
        config={
        # pull_request_on_stabilization_branches: To apply the action on all stabilization (including master) branches.
        # pull_request_title: The pull request title.
        # pull_request_body: The pull request body.
        # branch: The created branch branch name.
        # pull_request_branch_prefix: The created branch prefix (used when we run it on all the stabilization branches).
        },
    )

Use the --help option to see the available options.

Utilities

import multi_repo_automation as mra

# Test if a file exists
if mra.run(["git", "ls-files", "**/*.txt"], stdout=subprocess.PIPE).stdout.strip() != "":
  print("Found")
# Get all YAML files:
mra.all_filenames_identify("yaml")
# Test if a file exists and contains a text
if mra.git_grep(file, r"\<text\>"]):
  print("Found")
# Edit a files manually
mra.edit(["file"])

Edit file programmatically

   with mra.Edit('my-file.txt') as edit:
      edit.content = edit.content.replace('<from>', '<to>')

Edit YAML file programmatically

   with mra.EditYAML('my-file.yaml') as edit:
      edit.setdefault('dict', {})['prop'] = 'value'

Edit TOML file programmatically

   with mra.EditTOML('my-file.toml') as edit:
      edit.setdefault('dict', {})['prop'] = 'value'

Edit Config file programmatically

   with mra.EditConfigL('my-file.ini') as edit:
      edit.setdefault('dict', {})['prop'] = 'value'

Contributing

Install the pre-commit hooks:

pip install pre-commit
pre-commit install --allow-missing-config

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

multi_repo_automation-1.4.1.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

multi_repo_automation-1.4.1-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file multi_repo_automation-1.4.1.tar.gz.

File metadata

  • Download URL: multi_repo_automation-1.4.1.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for multi_repo_automation-1.4.1.tar.gz
Algorithm Hash digest
SHA256 d0f2ecc88489ec04b667790490827c5f09c9f21bc6615a41e85d71b41ebb69ac
MD5 518f22731ea5b840c39332b841822ba9
BLAKE2b-256 613b907b58e2c6975a0f15356ab061124d3c9352f0bf4497129ff322c8cc2959

See more details on using hashes here.

Provenance

File details

Details for the file multi_repo_automation-1.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for multi_repo_automation-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 300f299fa4d1e11aa4865f0308afa3a1bcd54a467a2a88b8191166e2b51a9608
MD5 6d4b7dd4921b0d96f7d96f8cd99b2443
BLAKE2b-256 1a27f02155ab18a0d9bae07a846fa802f1fa48b1b1c6b51746b7e83902bc2d2c

See more details on using hashes here.

Provenance

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