first stab at release notes

docs/source/index.rst

@@ -31,6 +31,7 @@ Contents
     server_bootstrap
     server_howto
     using_the_koji_build_system
+    profiles
     plugins
     writing_a_plugin
     writing_koji_code

docs/source/migrating_to_1.13.rst

@@ -0,0 +1,54 @@
+Migrating to Koji 1.13
+======================
+
+..
+  reStructured Text formatted
+
+The 1.13 release of Koji includes a several changes that you should consider when
+migrating.
+
+DB Updates
+----------
+
+We have increased the length limit for tag names and there is a minor schema
+change to support this.
+
+As in previous releases, we provide a migration script that updates the
+database.
+
+::
+
+    # psql koji koji  </usr/share/doc/koji/docs/schema-upgrade-1.12-1.13.sql
+
+
+Command line changes
+--------------------
+
+For full details see the release notes.
+
+New commands: ``list-channels``, ``hostinfo``
+
+The ``restart-hosts`` command takes several new options and now defaults to
+a 24 hour timeout.
+
+
+Packaging changes
+-----------------
+
+Because the CLI and base library now support both python2 and python3, the core libs
+and most of the cli code have moved to separate packages for each major Python
+version:
+
+    * python2-koji
+    * python3-koji
+
+The main koji package still contains the (now much smaller) koji script.
+
+The CLI now also supports plugins, and two commands (runroot and
+save-failed-tree) have moved to the ``python[23]-koji-cli-plugins`` subpackages.
+
+
+Configuration
+-------------
+
+The ``allowed_scms`` option supports a new syntax. See the release notes for details.

docs/source/migrations.rst

@@ -5,6 +5,7 @@ Migrations
 .. toctree::
     :maxdepth: 1
 
+    migrating_to_1.13
     migrating_to_1.12
     migrating_to_1.11
     migrating_to_1.10

docs/source/release_notes_1.13.rst

@@ -0,0 +1,175 @@
+Koji 1.13 Release Notes
+=======================
+
+Migrating from Koji 1.12
+------------------------
+
+For details on migrating see :doc:`migrating_to_1.13`
+
+
+Changes to the Web interface
+----------------------------
+
+Build Log Display
+^^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/471
+
+The build info pages now display the log files for a build (instead of linking
+directly to the directory on the download server). This works for all builds,
+including those imported by content generators.
+
+
+UNSORTED
+--------
+
+Configuring mock chroot behavior
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/400
+Issue: https://pagure.io/koji/issue/398
+
+Koji now supports using mock's --new-chroot option on a per-tag basis.
+For details see: :ref:`tuning-mock-per-tag`
+
+
+Enhancements to restart-hosts
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/472
+
+
+The `restart-hosts` command is used by admins to safely restart the build hosts
+after a configuration change.
+
+Because multiple restarts can confict, the command will now exit with a error
+if a restart is already underway (can be overridden with --force).
+
+There are now options to limit the restart to a given channel or arch.
+
+The command now has a timeout option, which defaults to 24hrs.
+
+
+pre/postSCMCheckout callbacks
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The callback interface is used by plugins to hook into various Koji operations.
+With this release we have added callbacks in the builder daemon for before and
+after source checkout: ``preSCMCheckout`` and ``postSCMCheckout``.
+
+
+CLI Plugins
+^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/199
+
+The command line interface now has basic plugin support. The intended use case
+is for plugins to be able to add new subcommands.
+For details see: :ref:`plugin-cli-command`
+
+
+list-channels CLI command
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/442
+
+The new `list-channels` command lists the known channels for the system.
+
+::
+    Usage: koji list-channels
+    (Specify the --help global option for a list of other help options)
+
+    Options:
+      -h, --help  show this help message and exit
+      --quiet     Do not print header information
+
+
+hostinfo CLI command
+^^^^^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/399
+Issue: https://pagure.io/koji/issue/364
+
+The new ``hostinfo`` command shows basic information about a build host,
+similar to the web interface.
+
+::
+
+    Usage: lkoji hostinfo [options] <hostname> [<hostname> ...]
+    (Specify the --help global option for a list of other help options)
+
+    Options:
+      -h, --help  show this help message and exit
+
+
+mod_auth_gssapi required
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/444
+
+On modern platforms, both koji-hub and koji-web now require
+mod_auth_gssapi instead of mod_auth_kerb.
+
+
+Python 3 client support
+^^^^^^^^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/417
+
+The koji command and core library now support Python 3 (as well as 2). The
+default spec now produces both `python2-koji` and `python3-koji` subpackages.
+The `koji` package still contains the (now much smaller) `/usr/bin/koji` file.
+
+Some older features are not supported by the Python 3 client
+
+    * the `use_old_ssl` option is not supported, python-requests must be used
+    * the old kerberos auth mechanism is not supported, use gssapi
+
+
+Extended allowed_scms format
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/421
+
+The allowed_scms option now accepts entries like:
+
+::
+
+    !host:repository
+
+to explicitly block a host:repository pattern.
+
+See also: :ref:`scm-config`
+
+
+
+Longer tag names
+^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/388
+Issue: https://pagure.io/koji/issue/369
+
+Previously, tag names were limited to 50 characters. They are now limited
+to 256 characters.
+
+
+User-Agent header
+^^^^^^^^^^^^^^^^^
+
+PR: https://pagure.io/koji/pull-request/393
+Issue: https://pagure.io/koji/issue/392
+
+Previously the Koji client library reported a confusingly out-of-date value
+in the `User-Agent` header. Now it simply reports the major version.
+
+
+raise error on non-existing profile
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+https://pagure.io/koji/pull-request/375
+https://pagure.io/koji/issue/370
+
+If the requested client profile is not configured, the library will raise an
+error, rather than proceeding with default values.
+
+See also: :doc:`profiles`

docs/source/server_howto.rst

@@ -1104,6 +1104,8 @@ By default it will look for the Kerberos keytab in ``/etc/kojid/kojid.keytab``
     Kojid will not attempt kerberos authentication to the koji-hub unless the
     username field is commented out
 
+.. _scm-config:
+
 Source Control Configuration
 ----------------------------
 

docs/source/using_the_koji_build_system.rst

@@ -403,6 +403,9 @@ for example to get the latest buildroot for dist-f12-build run
 you will need to pass in --topurl=https://kojipkgs.fedoraproject.org/ to
 any mock-config command to get a working mock-config from fedoras koji.
 
+
+.. _tuning-mock-per-tag:
+
 Tuning mock's behaviour per tag
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

docs/source/writing_a_plugin.rst

@@ -189,6 +189,9 @@ tagging a build:
 
     $ koji tag-build mytag mypkg-1.0-1
 
+
+.. _plugin-cli-command:
+
 New command for CLI
 -------------------