Fedora Easy Karma

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Frequently Asked Questions: start to write some workflows down)
(clean up some commands and wikifications, update the example output for current f-e-k)
Line 6: Line 6:
 
fedora-easy-karma allows you to easily portion out karma points for testing updates that you have currently installed. The typical workflow is as follows:
 
fedora-easy-karma allows you to easily portion out karma points for testing updates that you have currently installed. The typical workflow is as follows:
  
# install packages from updates-testing: {{command|su -c 'yum --enablerepo<nowiki>=</nowiki>updates-testing update}}
+
# install packages from [[QA/Updates_Testing|updates-testing]]: {{command|su -c 'yum --enablerepo<nowiki>=</nowiki>updates-testing update'}}
 
# Use these packages to identify breakage or directly run fedora-easy-karma and test packages according to the update notes
 
# Use these packages to identify breakage or directly run fedora-easy-karma and test packages according to the update notes
 
# Run fedora-easy-karma
 
# Run fedora-easy-karma
Line 19: Line 19:
  
 
You will be asked for every package installed from updates-testing to provide
 
You will be asked for every package installed from updates-testing to provide
feedback using karma points. If pattern are provided, you will be only prompted
+
feedback using karma points. If patterns are provided, you will be only prompted
 
for updates related to packages or builds that match any of the patterns.
 
for updates related to packages or builds that match any of the patterns.
 
Possible wildcards are *, ?, [seq] and [!seq] as explained at
 
Possible wildcards are *, ?, [seq] and [!seq] as explained at
 
http://docs.python.org/library/fnmatch.html
 
http://docs.python.org/library/fnmatch.html
After you have selected the karma points, you will be asked for a comment. An
+
After selecting the karma points, you will be asked for a comment. An empty
empty comments skips the package
+
comment skips the update.
  
 
Possible karma points are:
 
Possible karma points are:
Line 30: Line 30:
 
  0 : The update has not been tested much or at all
 
  0 : The update has not been tested much or at all
 
  1 : The update seems not to break anything new
 
  1 : The update seems not to break anything new
All other inputs will skip the update
+
All other inputs will skip the update.
 
You can use <CTRL>-<D> on an empty prompt to exit
 
You can use <CTRL>-<D> on an empty prompt to exit
 
If you use a default comment, '<CTRL>-<X> <backspace>' can be used to delete the
 
If you use a default comment, '<CTRL>-<X> <backspace>' can be used to delete the
Line 39: Line 39:
 
Please send bug reports and feature requests to
 
Please send bug reports and feature requests to
 
'Till Maas <opensource@till.name>'
 
'Till Maas <opensource@till.name>'
For patches please use 'git send-mail'.
+
For patches please use 'git send-email'.
  
 
Options:
 
Options:
 
   -h, --help            show this help message and exit
 
   -h, --help            show this help message and exit
  --no-skip-empty-comment
 
                        Do not skip update if comment is empty
 
 
   --bodhi-cached        Use cached bodhi query
 
   --bodhi-cached        Use cached bodhi query
 
   --bodhi-cachedir=BODHI_CACHEDIR
 
   --bodhi-cachedir=BODHI_CACHEDIR
Line 50: Line 48:
 
                         easy-karma
 
                         easy-karma
 
   --bodhi-update-cache  Update bodhi query cache
 
   --bodhi-update-cache  Update bodhi query cache
 +
  --critpath-only      Only consider unapproved critpath updates
 
   --debug              Enable debug output
 
   --debug              Enable debug output
 
   --default-comment=COMMENT
 
   --default-comment=COMMENT
Line 66: Line 65:
 
                         Only check packages installed for at least XX days,
 
                         Only check packages installed for at least XX days,
 
                         default: 0
 
                         default: 0
 +
  --list-rpms-only      Only list affected rpms
 +
  --no-skip-empty-comment
 +
                        Do not skip update if comment is empty
 
   --product=PRODUCT    product to query Bodhi for, 'F' for Fedora, 'EL-' for
 
   --product=PRODUCT    product to query Bodhi for, 'F' for Fedora, 'EL-' for
 
                         EPEL, default: F
 
                         EPEL, default: F
Line 117: Line 119:
 
=== Update Everything, then look at updates and perform some direct testing ===
 
=== Update Everything, then look at updates and perform some direct testing ===
 
First update:
 
First update:
  yum update --enablerepo="*-testing"
+
  {{command|yum update --enablerepo="*-testing"}}
 
The run fedora-easy-karma:
 
The run fedora-easy-karma:
  fedora-easy-karma
+
  {{command|fedora-easy-karma}}
 
Now read the presented update information. If there is an update to would like to test, do it now in parallel, e.g. if it is a text editor, run it, open some files, edit something etc. If you are content with the application, enter "1" in fedora-easy-karma and describe what you did. If something broke, please file a bug report, enter "-1" in fedora-easy-karma and mention the bug in the comment. If you do not know how to test the package, just skip it hitting "Enter".
 
Now read the presented update information. If there is an update to would like to test, do it now in parallel, e.g. if it is a text editor, run it, open some files, edit something etc. If you are content with the application, enter "1" in fedora-easy-karma and describe what you did. If something broke, please file a bug report, enter "-1" in fedora-easy-karma and mention the bug in the comment. If you do not know how to test the package, just skip it hitting "Enter".
  
 
== Frequently Asked Questions ==
 
== Frequently Asked Questions ==
* Q: I just updated package foo from updates-testing, but when I run fedora-easy-karma, why I am not asked for Feedback?
+
* Q: I just updated package foo from updates-testing, but when I run fedora-easy-karma, why I am not asked for feedback?
 
: A: The update for the package is probably already requested to become stable or maybe to be unpushed from testing. You will not be asked for feedback on such updates. If you found a new bug, please open a bug report instead.
 
: A: The update for the package is probably already requested to become stable or maybe to be unpushed from testing. You will not be asked for feedback on such updates. If you found a new bug, please open a bug report instead.
  
 
== Source ==
 
== Source ==
 
Currently the source is available at a [http://fedorapeople.org/gitweb?p=till/public_git/fedora-easy-karma.git Fedorapeople git repository]
 
Currently the source is available at a [http://fedorapeople.org/gitweb?p=till/public_git/fedora-easy-karma.git Fedorapeople git repository]

Revision as of 20:38, 13 July 2010

Quick Links
gitweb

fedora-easy-karma allows you to easily portion out karma points for testing updates that you have currently installed. The typical workflow is as follows:

  1. install packages from updates-testing: su -c 'yum --enablerepo=updates-testing update'
  2. Use these packages to identify breakage or directly run fedora-easy-karma and test packages according to the update notes
  3. Run fedora-easy-karma

Contents

Installation

You need version 0.4.0 or greater of Package-x-generic-16.pngfedora-packager to use this script. You can install Package-x-generic-16.pngfedora-easy-karma for any supported Fedora release by using the command: su -c 'yum --enablerepo=updates-testing install fedora-easy-karma'

Example Output

$ fedora-easy-karma --help
Usage: fedora-easy-karma [options] [pattern, ..]

You will be asked for every package installed from updates-testing to provide
feedback using karma points. If patterns are provided, you will be only prompted
for updates related to packages or builds that match any of the patterns.
Possible wildcards are *, ?, [seq] and [!seq] as explained at
http://docs.python.org/library/fnmatch.html
After selecting the karma points, you will be asked for a comment. An empty
comment skips the update.

Possible karma points are:
-1 : Update breaks something or does not fix a bug it is supposed to
 0 : The update has not been tested much or at all
 1 : The update seems not to break anything new
All other inputs will skip the update.
You can use <CTRL>-<D> on an empty prompt to exit
If you use a default comment, '<CTRL>-<X> <backspace>' can be used to delete the
default comment to easily enter a custom one.

The source can be found at
http://fedorapeople.org/gitweb?p=till/public_git/fedora-easy-karma.git;a=summary
Please send bug reports and feature requests to
'Till Maas <opensource@till.name>'
For patches please use 'git send-email'.

Options:
  -h, --help            show this help message and exit
  --bodhi-cached        Use cached bodhi query
  --bodhi-cachedir=BODHI_CACHEDIR
                        Directory to store bodhi cache, default: ~/.fedora-
                        easy-karma
  --bodhi-update-cache  Update bodhi query cache
  --critpath-only       Only consider unapproved critpath updates
  --debug               Enable debug output
  --default-comment=COMMENT
                        Default comment to use, default:
  --default-karma=KARMA
                        Default karma to use, default:
  --fas-username=FAS_USERNAME
                        FAS username
  --include-commented   Also ask for more comments on updates that already got
                        a comment from you, this is enabled if patterns are
                        provided
  --installed-max-days=DAYS
                        Only check packages installed within the last XX days,
                        default: 28
  --installed-min-days=DAYS
                        Only check packages installed for at least XX days,
                        default: 0
  --list-rpms-only      Only list affected rpms
  --no-skip-empty-comment
                        Do not skip update if comment is empty
  --product=PRODUCT     product to query Bodhi for, 'F' for Fedora, 'EL-' for
                        EPEL, default: F
  --releasever=RELEASEVER
                        releasever to query Bodhi for, default: releasever
                        from yum
  --retries=RETRIES     Number if retries when submitting a comment in case of
                        an error, default: 3
  --wrap-bugs           Apply line-wrapping to bugs
  --wrap-rpms           Apply line-wrapping to list of installed rpms
  --wrap-width=WRAP_WIDTH
                        Width to use for line wrapping of updates, default: 80
$ fedora-easy-karma
================================================================================
     git-cola-1.4.1.2-2.fc12, python-jsonpickle-0.3.1-1.fc12
================================================================================
  Update ID: FEDORA-2010-1627
    Release: Fedora 12
     Status: testing
       Type: bugfix
      Karma: 0
       Bugs: https://bugzilla.redhat.com/546131 - Desktop file for git-cola should be more specific than "Cola"
           : https://bugzilla.redhat.com/532499 - git-cola ships a copy of jsonpickle
           : https://bugzilla.redhat.com/543248 - Review Request: python-jsonpickle - A module that allows any object to be serialized into JSON
      Notes:  * git-cola no longer ships copies of python-jsonpickle and python-
           : simplejson
           :  * "Classic" GUI option (similar to gitk)
           :  * Fixed keyboard shotcuts (all use modifiers)
           :  * Vim keybindings to the treeview
           :  * Better renaming handling
           :  * Check for upstream changes
           :  * Can clone a repository from the gui
           :  * Support for more git commands
  Submitter: mathstuf
  Submitted: 2010-02-06 21:30:22
   Comments: mathstuf - 2010-02-06 21:30:48 (karma 0)
             This update has been submitted for testing
             bodhi - 2010-02-09 04:59:01 (karma 0)
             This update has been pushed to testing

  https://admin.fedoraproject.org/updates/F12/FEDORA-2010-1627

 inst. RPMS: git-cola-1.4.1.2-2.fc12.noarch
           : python-jsonpickle-0.3.1-1.fc12.noarch
Comment? -1/0/1 ->karma, other -> skip> 1
Comment> git-cola works without obvious breakage for some read only operations
FAS Password for till:

Example Workflows

Update Everything, then look at updates and perform some direct testing

First update:

{{{1}}}

The run fedora-easy-karma:

fedora-easy-karma

Now read the presented update information. If there is an update to would like to test, do it now in parallel, e.g. if it is a text editor, run it, open some files, edit something etc. If you are content with the application, enter "1" in fedora-easy-karma and describe what you did. If something broke, please file a bug report, enter "-1" in fedora-easy-karma and mention the bug in the comment. If you do not know how to test the package, just skip it hitting "Enter".

Frequently Asked Questions

  • Q: I just updated package foo from updates-testing, but when I run fedora-easy-karma, why I am not asked for feedback?
A: The update for the package is probably already requested to become stable or maybe to be unpushed from testing. You will not be asked for feedback on such updates. If you found a new bug, please open a bug report instead.

Source

Currently the source is available at a Fedorapeople git repository