Skip to main content

Diff Helper for Continuous Integration (CI) Services

coverage Documentation Status

For an open source project, running unit tests, system tests, torture tests, fuzz tests, integration tests, code quality checks, etc. can quickly become a large task.

In order to limit the amount of time and resources that these jobs require, this tool provides a way to determine which files have changed and provides a Python API for these changes. In addition, this library provides the corresponding commit SHA (or other artifact) that is used as the diffbase.

The library supports (planned)

Install

$ pip install --upgrade ci-diff-helper

See It In Action

The test-app branch is set up to run every time a change is made. Check out the latest Travis builds in test-app, the latest CircleCI builds and the latest AppVeyor builds to see the computed values at work.

For example, in a Travis PR build:

Config object: <Travis (active=True)>
----------------------------------------
    active: True
      base: 'test-app'
    branch: 'test-app'
event_type: <TravisEventType.pull_request: 'pull_request'>
     in_pr: True
  is_merge: True
 merged_pr: None
        pr: 10
      slug: 'dhermes/ci-diff-helper'
       tag: None
       ...

and in a Travis push build:

Config object: <Travis (active=True)>
----------------------------------------
    active: True
      base: u'4a02445642735ba0d3ce5b944f4b2647b4c55813'
    branch: 'test-app'
event_type: <TravisEventType.push: 'push'>
     in_pr: False
  is_merge: True
 merged_pr: 10
        pr: None
      slug: 'dhermes/ci-diff-helper'
       tag: None
       ...

A CircleCI push build:

Config object: <CircleCI (active=True)>
----------------------------------------
    active: True
    branch: 'test-app'
  is_merge: True
       tag: None
       ...

An AppVeyor push build:

Config object: <AppVeyor (active=True)>
----------------------------------------
    active: True
    branch: 'test-app'
  is_merge: True
  provider: <AppVeyorRepoProvider.github: 'github'>
       tag: None
       ...

License

Apache 2.0 - See LICENSE for more information.

Metadata

Release files for ci-diff-helper 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ci-diff-helper 0.2.0
File Size Uploaded Provenance
ci-diff-helper-0.2.0.tar.gz 25.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ci-diff-helper 0.2.0
File Interpreter ABI Platform
ci_diff_helper-0.2.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 66.3 kB

Release files / ci-diff-helper-0.2.0.tar.gz

Download URL ci-diff-helper-0.2.0.tar.gz
Size 25.2 kB
Tags Source
SHA-256 checksum
How to use checksums
b85d494787f3f925b7fdcdc1cf1ae045f46cd85cfec75410b8ce954fdbac83a8
BLAKE2b-256 checksum
How to use checksums
7a0d0e6ee66f0e04fb7606ca834f9ff920c34731487ed0f1b4f267c5b6e24421
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / ci_diff_helper-0.2.0-py2.py3-none-any.whl

Download URL ci_diff_helper-0.2.0-py2.py3-none-any.whl
Size 41.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
9d4d076d763f5b279735251e433b7a266e4d86de72c0259b7115f78d108f3114
BLAKE2b-256 checksum
How to use checksums
40595135cc401411090f029f8c8ea886c7f601c42fa19cc13368676605fe2c06
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for ci-diff-helper 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files No provenance

0.0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page