Skip to content

Latest commit

 

History

History
103 lines (83 loc) · 2.61 KB

README.md

File metadata and controls

103 lines (83 loc) · 2.61 KB
Raw

version-check

A simple tool to search Salt branches and tags for pull requests.

This tool takes a pull request number and outputs the list of branches and/or tags it is included in.

Note: A git fetch is performed at the beginning of the main Python function. This provides the most up-to-date search results for the query. This functionality can be avoided by passing the skip-fetch flag.

Installation

The following steps will walk you through building the Docker image needed to use this tool.

These steps assume Docker is already installed. If you haven't previously installed Docker, follow these installation instructions.

First, clone this repo. Then, change directories to the new clone:

$ git clone https://github.com/rallytime/version-check.git
$ cd version-check/

Next, build the Docker container:

$ docker build -t version_check .

You should now be ready to use version_check to identify the branches and tags that your pull request is contained in.

Usage

The docker build step above copies version_check.py into the image and sets an entrypoint to run the file with Python. That way, you can provide the script arguments for the tool directly to the container:

$ docker run --rm -it version_check -h

Options

version_check allows you to provide a pull request number or a commit hash (but not both) to query Salt branches and releases.

PR Example:

$ docker run --rm -it version_check -p 42890
Branches:
  2016.11
  2016.11.8
  2017.7
  2017.7.2
  develop
Tags:
  v2016.11.8
  v2017.7.2

Commit Example (same PR number, but using a commit hash instead):

$ docker run --rm -it version_check -c 999388680ca67d9d2aafa6c0fbc3acc5d8389208
Branches:
  2016.11
  2016.11.8
  2017.7
  2017.7.2
  develop
Tags:
  v2016.11.8
  v2017.7.2

Narrowing Search Results

You can also narrow your search to scan specific branches or tags:

$ docker run --rm -it version_check -p 42890 -b 2017.7 -t v2016.11.8
Branches:
  2017.7
Tags:
  v2016.11.8

Multiple branches or tags can also be used:

$ docker run --rm -it version_check -p 42890 -b 2017.7 -b develop
Branches:
  2017.7
  develop

skip_fetch

It's possible to avoid running a git fetch every time the version_check script is executed by passing the --skip-fetch flag. This is desirable when a container already contains the latest references from GitHub.

NOTE Passing --skip-fetch will decrease search times significantly, but be aware it may cause inconsistent search results if the clone is not up-to-date.