Skip to main content

Cron-based remote pre-commit executions by opening pull requests.

Project description

repo-stream

Cron-based remote pre-commit executions by opening pull requests.

Do you've a lot of old projects that are using deprecated configuration? Maybe you want to do a small change in a lot of projects at the same time, but you don't want to go one by one? Those are the reasons behind repo-stream.

PyPI version Test Coverage status

How does it work?

Scans your repositories looking for pre-commit repo-stream hooks and run pre-commit using another remote configuration file. If this execution edit file contents, opens a pull request against the repository.

So you can use repo-stream to run one-time pre-commit hooks for all your repositories without have to define them inside the configuration of each one.

Usage

  1. Create a repo-stream hook in your pre-commit configuration. If this is found, repo-stream will search a pre-commit configuration file at updater under config repository and will run it against the current repository. If a hook makes a change, a pull request will be created.
- repo: https://github.com/mondeja/repo-stream
  rev: v1.3.0
  hooks:
    - id: repo-stream
      args:
        - -config=https://github.com/<your-username>/repo-stream-config
        - -updater=upstream
  1. Create your repo-stream configuration files repository, for example at https://github.com/<your-username>/repo-stream-config.
  2. Create the pre-commit configuration file, following this example would be at upstream.yaml, for example:
repos:
  - repo: https://github.com/mondeja/pre-commit-hooks
    rev: v1.3.0
    hooks:
      - id: add-pre-commit-hook
        args: 
          - -repo=https://github.com/mondeja/pre-commit-hooks
          - -id=dev-extras-required
          - -rev=v1.3.0
  1. Create the cron task using some platform like Github Actions:
name: repo-stream update

on:
  schedule:
    - cron: 0 4 1/7 * *
  workflow_dispatch:

jobs:
  repo-stream-update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.x
      - name: Install repo-stream
        run: pip install repo-stream
      - name: Run repo-stream update
        run: repo-stream <your-username>
        env:
          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
          GITHUB_USERNAME: <your-username>
  • GH_TOKEN must be a secret configured for the repository with the Github user token of <your-username> user.
  • If you want to update other repositories not published under your user, pass them as parameters of repo-stream <your-username> <other-username>.

Consult repo-stream --help for documentation about valid arguments.

Usage as Github Action

name: repo-stream update

on:
  schedule:
    - cron: 0 4 1/7 * *
  workflow_dispatch:

jobs:
  repo-stream-update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-python@v2
        with:
          python-version: 3.x
      - uses: mondeja/repo-stream@v1.3.0
        with:
          usernames: <your-username> <other-username>
          args: --dry-run
        env:
          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
          GITHUB_USERNAME: <your-username>

Current limitations

  • Only works with Github repositories.

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 repo-stream, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size repo_stream-1.3.0-py3-none-any.whl (13.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size repo_stream-1.3.0.tar.gz (13.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page