From 487a15f1b0a206331639c0c79c9cbf76bdf27ef6 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Thu, 12 Sep 2013 15:25:03 -0400 Subject: [PATCH] Update copyright and readme --- README.rst | 33 +++++++++++++++++++++++++++++++++ git_os_job/cmd.py | 15 ++++++++++++++- setup.cfg | 2 +- setup.py | 5 ++--- 4 files changed, 50 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 3afe52f..6255107 100644 --- a/README.rst +++ b/README.rst @@ -2,3 +2,36 @@ git-os-job ========== git plugin to show the OpenStack job log for a commit + +What is git-os-job? +------------------- + +The OpenStack_ project stores the logs for all of the test jobs +related to a commit on http://logs.openstack.org organized by the +commit hash. To review the logs after a job runs, most developers +start with the message jenkins leaves on gerrit, and click through to +the log files. Not all jenkins jobs are triggered by or related to a +gerrit review, though (e.g, release tags). + +git-os-job makes it easy to find those logs by finding the hash of the +commit and using it to build the right URL. It will then either print +the URL or open a web browser directly. + +Examples +-------- + +Look at the jobs related to the ``HEAD`` commit, usually in a +development branch that has been submitted to gerrit using git-review_ +already.:: + + $ git os-job + +Look at the jobs related to the previous commit, such as when a +development branch has a series of independent changes in it:: + + $ git os-job HEAD^1 + +Look at the jobs related to a specific commit by tag, such as after +submitting a release tag:: + + $ git os-job version.tag diff --git a/git_os_job/cmd.py b/git_os_job/cmd.py index 198a9bc..f7fcb64 100755 --- a/git_os_job/cmd.py +++ b/git_os_job/cmd.py @@ -1,4 +1,17 @@ -#!/usr/bin/env python +# Copyright (c) 2013 Doug Hellmann +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. from __future__ import print_function diff --git a/setup.cfg b/setup.cfg index 0d22313..7082661 100644 --- a/setup.cfg +++ b/setup.cfg @@ -7,7 +7,7 @@ classifiers = Programming Language :: Python :: 2 Programming Language :: Python :: 3 Programming Language :: Python - Development Status :: 3 - Alpha + Development Status :: 5 - Production/Stable Environment :: Console Environment :: OpenStack Intended Audience :: Developers diff --git a/setup.py b/setup.py index 1a1024d..8e2dc1b 100755 --- a/setup.py +++ b/setup.py @@ -1,5 +1,5 @@ #!/usr/bin/env python -# Copyright (c) 2013 New Dream Network, LLC (DreamHost) +# Copyright (c) 2013 Doug Hellmann # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,5 +17,4 @@ import setuptools -setuptools.setup(setup_requires=['pbr>=0.5.21,<1.0'], - pbr=True) +setuptools.setup(setup_requires=['pbr'], pbr=True)