From f44c97f6777861ff8de97191cc85dd5836bd92c3 Mon Sep 17 00:00:00 2001 From: Chenxiong Qi Date: Jul 22 2018 07:42:57 +0000 Subject: 1.34 Release From this release, release notes move to a documentation website generated by sphinx, into which more content about fedpkg could be put in the future. Change logs are moved from CHANGELOG.rst to separate release notes, each of them is a standalone web page in the site. Command request-repo help text is updated as well. Signed-off-by: Chenxiong Qi --- diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a41e229..837106b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,135 +1,4 @@ ChangeLog ========= -1.33 (2018-05-14) ------------------ - -- Allow running tests against specified rpkg (cqi) -- Fix test due to rpkg uses getpass.getuser (cqi) -- Getting bodhi version works with Python 3 - #213 (cqi) -- Detect Bodhi client by major version - #204 (cqi) -- Allow requesting modular repositories without bug ID - #197 (rdossant) -- Fix test test_verify_sls_invalid_date - #209 (cqi) -- Copy pip-pycurl to ensure pycurl is installed correctly (cqi) -- Fix unicode issue for update command in Python 3 - #206 (cqi) -- Fix a few E722 code styles errors (cqi) -- Fix fake PDC URL in test (cqi) -- Use tox to run tests with multiple Python versions (cqi) -- Reword error message for missing pagure token - #194 (cqi) -- Tell which token ACL is required for request-repo - #195 (cqi) -- Rename incorrect references of Koshei to be Anitya (mprahl) - -1.32 (2018-03-01) ------------------ - -- Add requests-tests-repo command (mvadkert) -- Use PDC instead of Bodhi to get the active release branches - #187 (mprahl) -- fix broken syntax in bash completion (tmz) -- Fix Python 3 incompatible code in tests (cqi) -- Better mocking. Return different values for each new request. (rbean) -- Typofix. (rbean) -- Add docstrings. (rbean) -- Automatically request module for non-standard branches. (rbean) -- Refactor: parameterize the request_repo and request_branch functionality. - (rbean) -- Some additions to the gitignore file. (rbean) - -1.31 (2018-01-22) ------------------ - -- Include missing conf file in test (cqi) -- Add more document to request-repo and request-branch (cqi) -- Stop allowing EPEL branches on official EL packages (mprahl) -- Port fedrepo-req and fedrepo-req-branch to fedpkg (mprahl) -- Fix test for unsupported Bodhi version (lsedlar) -- Work with Bodhi 3 - rhbz#1507410 (lsedlar) -- Allow any parameters in construct_build_url (cqi) -- Fix the anongiturl (patrick) - -1.30 (2017-10-20) ------------------ - -- Add missing files to dist tarball (cqi) -- Tests for update command (cqi) -- Add support for module commands (mprahl) -- Clean rest cert related code (cqi) -- Remove fedora cert (cqi) -- Override build URL for Koji (cqi) -- changing anongiturl to use src.fp.o instead of pkgs.fp.o. - #119 (tflink) -- Add tests (cqi) -- Enable lookaside_namespaced - #130 (cqi) -- Detect dist tag correctly for RHEL and CentOS - #141 (cqi) -- Remove deprecated call to platform.dist (cqi) -- Do not prompt hint for SSL cert if fail to log into Koji (cqi) -- Add more container-build options to bash completion (cqi) -- Remove osbs from bash completion - #138 (cqi) -- Install executables via entry_points - #134 (cqi) -- Fix container build target (lsedlar) -- Get correct build target for rawhide containers (lsedlar) -- Update error message to reflect deprecation of --dist option (pgier) - -v1.29 (2017-08-11) ------------------- - -- Remove unused variable in Commands.retire (cqi) -- No more pkgdb. (rbean) -- Add --arches to build completions (ville.skytta) -- Add ppc64le to arch completions (ville.skytta) -- Explain how to write a note in multiple lines in update template - #123 (cqi) -- Remove code that handles secondary arch (cqi) -- Simplify passing arguments when creating Command object - #14 (cqi) -- Set koji profile for secondary arch immediately (cqi) -- Use profile to load Koji configuration - #97 (cqi) -- Remove push.default from clone_default - #109 (cqi) -- remove special handling of s390 specific packages (dan) -- Replace fedorahosted.org with pagure.io in manpage - #113 (cqi) -- Remove tracbaseurl from conf file - #112 (cqi) -- Set disttag properly (cqi) -- koji stage config moved, update fedpkg defaults (maxamillion) -- Specific help of --release for fedpkg - rhbz#1054440 (cqi) - -v1.28 (2017-02-24) ------------------- - -- Restore anonymous clone link - rhbz#1425913 (cqi) - -v1.27 (2017-02-22) ------------------- - -- Python 3.6 invalid escape sequence deprecation fixes (ville.skytta) -- Disable tag inheritance check - #98 (cqi) - -v1.26 (2016-12-15) ------------------- - -- fedpkg clone -a uses https transport - BZ#1188634 (cqi) -- Fix handle unicode chars in git log - BZ#1404724 (cqi) -- Fix: make fedpkg workable with bodhi 2 CLI - #87 (cqi) -- Fix --dist/--release option for 'master' %dist detection (praiskup) -- sha512 should be also used in fedpkg-stage (cqi) -- conf: s/kerberos_realm/kerberos_realms/ (i.gnatenko.brain) -- Update config with new lookaside url (puiterwijk) -- Use system trust list for lookaside (puiterwijk) -- Specific help of --release for fedpkg - rhbz#1054440 (cqi) -- Bash completion for --mock-config (cqi) -- Remove unnecessary entry point (cqi) -- Add missing import to man page script (lsedlar) -- lookaside: We now use sha512 to upload the sources (bochecha) -- Move to the new sources file format (bochecha) -- Fix man page generator (lsedlar) -- Accept the realms argument in Commands class - #14 (lsedlar) -- Add kerberos realm to config files (lsedlar) -- Move release guide to doc directory (cqi) -- Add --with-changelog to shell completion (cqi) -- Avoid sys.exit - #52 (cqi) -- Add --release to bash completion (cqi) -- remove the ppc and arm packages as they are now built in regular koji - (dennis) -- Do not send a certificate if none exists (puiterwijk) -- New source code layout (cqi) -- Set push.default to simple (cqi) -- Fix PEP8 errors (cqi) -- Integration between setuptools and nosetests (cqi) -- New fedpkg-stage for developers to use stage infra - #41 (cqi) -- enable target dest for rawhide to have trailing pieces (dennis) -- python3: improve Python 3.x compatibility (pavlix) +Please refer to https://docs.pagure.io/fedpkg/releases.html diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..912c836 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = fedpkg +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/doc/source/_static/placeholder b/doc/source/_static/placeholder new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/doc/source/_static/placeholder diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..79dcd5f --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,160 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'fedpkg' +copyright = '2018, fedpkg Team' +author = 'fedpkg Team' + +# The short X.Y version +version = '1.34' +# The full version, including alpha/beta/rc tags +release = '1.34' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'fedpkgdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'fedpkg.tex', 'fedpkg Documentation', + 'fedpkg Team', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'fedpkg', 'fedpkg Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'fedpkg', 'fedpkg Documentation', + author, 'fedpkg', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Extension configuration ------------------------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..0de3c57 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,21 @@ +.. fedpkg documentation master file, created by + sphinx-quickstart on Thu Jul 19 11:32:04 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to fedpkg's documentation! +================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + releases + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/releases.rst b/doc/source/releases.rst new file mode 100644 index 0000000..ed02105 --- /dev/null +++ b/doc/source/releases.rst @@ -0,0 +1,17 @@ +.. _releases: + +Releases +======== + +.. toctree:: + :maxdepth: 1 + + releases/1.34 + releases/1.33 + releases/1.32 + releases/1.31 + releases/1.30 + releases/1.29 + releases/1.28 + releases/1.27 + releases/1.26 diff --git a/doc/source/releases/1.26.rst b/doc/source/releases/1.26.rst new file mode 100644 index 0000000..72ccfff --- /dev/null +++ b/doc/source/releases/1.26.rst @@ -0,0 +1,54 @@ +.. _release_1.26: + +fedpkg 1.26 Release Notes +========================= + +Released on *December 15, 2016* + +Python compatibility +-------------------- + +fedpkg works with Python 2.6, 2.7 and 3.6. + +Change Logs +----------- + +- fedpkg clone -a uses https transport - `BZ#1188634`_ (cqi) +- Fix handle unicode chars in git log - `BZ#1404724`_ (cqi) +- Fix: make fedpkg workable with bodhi 2 CLI - `#87`_ (cqi) +- Fix --dist/--release option for 'master' %dist detection (praiskup) +- sha512 should be also used in fedpkg-stage (cqi) +- conf: s/kerberos_realm/kerberos_realms/ (i.gnatenko.brain) +- Update config with new lookaside url (puiterwijk) +- Use system trust list for lookaside (puiterwijk) +- Specific help of --release for fedpkg - `rhbz#1054440`_ (cqi) +- Bash completion for --mock-config (cqi) +- Remove unnecessary entry point (cqi) +- Add missing import to man page script (lsedlar) +- lookaside: We now use sha512 to upload the sources (bochecha) +- Move to the new sources file format (bochecha) +- Fix man page generator (lsedlar) +- Accept the realms argument in Commands class - `#14`_ (lsedlar) +- Add kerberos realm to config files (lsedlar) +- Move release guide to doc directory (cqi) +- Add --with-changelog to shell completion (cqi) +- Avoid sys.exit - `#52`_ (cqi) +- Add --release to bash completion (cqi) +- remove the ppc and arm packages as they are now built in regular koji + (dennis) +- Do not send a certificate if none exists (puiterwijk) +- New source code layout (cqi) +- Set push.default to simple (cqi) +- Fix PEP8 errors (cqi) +- Integration between setuptools and nosetests (cqi) +- New fedpkg-stage for developers to use stage infra - `#41`_ (cqi) +- enable target dest for rawhide to have trailing pieces (dennis) +- python3: improve Python 3.x compatibility (pavlix) + +.. _`#14`: https://pagure.io/rpkg/issue/14 +.. _`#41`: https://pagure.io/rpkg/issue/41 +.. _`#52`: https://pagure.io/rpkg/issue/52 +.. _`#87`: https://pagure.io/rpkg/issue/87 +.. _`BZ#1188634`: https://bugzilla.redhat.com/show_bug.cgi?id=1188634 +.. _`BZ#1404724`: https://bugzilla.redhat.com/show_bug.cgi?id=1404724 +.. _`rhbz#1054440`: https://bugzilla.redhat.com/show_bug.cgi?id=1054440 diff --git a/doc/source/releases/1.27.rst b/doc/source/releases/1.27.rst new file mode 100644 index 0000000..4b9607f --- /dev/null +++ b/doc/source/releases/1.27.rst @@ -0,0 +1,19 @@ +.. _release_1.27: + +fedpkg 1.27 Release Notes +========================= + +Released on *February 22, 2017* + +Python compatibility +-------------------- + +fedpkg works with Python 2.6, 2.7 and 3.6. + +Change Logs +----------- + +- Python 3.6 invalid escape sequence deprecation fixes (ville.skytta) +- Disable tag inheritance check - `#98`_ (cqi) + +.. _`#98`: https://pagure.io/rpkg/issue/98 diff --git a/doc/source/releases/1.28.rst b/doc/source/releases/1.28.rst new file mode 100644 index 0000000..2a6c35e --- /dev/null +++ b/doc/source/releases/1.28.rst @@ -0,0 +1,18 @@ +.. _release_1.28: + +fedpkg 1.28 Release Notes +========================= + +Released on *February 24, 2017* + +Python compatibility +-------------------- + +fedpkg works with Python 2.6, 2.7 and 3.6. + +Change Logs +----------- + +- Restore anonymous clone link - `rhbz#1425913`_ (cqi) + +.. _`rhbz#1425913`: https://bugzilla.redhat.com/show_bug.cgi?id=1425913 diff --git a/doc/source/releases/1.29.rst b/doc/source/releases/1.29.rst new file mode 100644 index 0000000..167efe7 --- /dev/null +++ b/doc/source/releases/1.29.rst @@ -0,0 +1,39 @@ +.. _release_1.29: + +fedpkg 1.29 Release Notes +========================= + +Released on *August 11, 2017* + +Python compatibility +-------------------- + +fedpkg works with Python 2.6, 2.7 and 3.6. + +Change Logs +----------- + +- Remove unused variable in Commands.retire (cqi) +- No more pkgdb. (rbean) +- Add --arches to build completions (ville.skytta) +- Add ppc64le to arch completions (ville.skytta) +- Explain how to write a note in multiple lines in update template - `#123`_ (cqi) +- Remove code that handles secondary arch (cqi) +- Simplify passing arguments when creating Command object - `#14`_ (cqi) +- Set koji profile for secondary arch immediately (cqi) +- Use profile to load Koji configuration - `#97`_ (cqi) +- Remove push.default from clone_default - `#109`_ (cqi) +- remove special handling of s390 specific packages (dan) +- Replace fedorahosted.org with pagure.io in manpage - `#113`_ (cqi) +- Remove tracbaseurl from conf file - `#112`_ (cqi) +- Set disttag properly (cqi) +- koji stage config moved, update fedpkg defaults (maxamillion) +- Specific help of --release for fedpkg - `rhbz#1054440`_ (cqi) + +.. _`#14`: https://pagure.io/rpkg/issue/14 +.. _`#97`: https://pagure.io/rpkg/issue/97 +.. _`#109`: https://pagure.io/rpkg/issue/109 +.. _`#112`: https://pagure.io/rpkg/issue/112 +.. _`#113`: https://pagure.io/rpkg/issue/113 +.. _`#123`: https://pagure.io/rpkg/issue/123 +.. _`rhbz#1054440`: https://bugzilla.redhat.com/show_bug.cgi?id=1054440 diff --git a/doc/source/releases/1.30.rst b/doc/source/releases/1.30.rst new file mode 100644 index 0000000..31cfc09 --- /dev/null +++ b/doc/source/releases/1.30.rst @@ -0,0 +1,39 @@ +.. _release_1.30: + +fedpkg 1.30 Release Notes +========================= + +Released on *October 10, 2017* + +Python compatibility +-------------------- + +fedpkg works with Python 2.6, 2.7 and 3.6. + +Change Logs +----------- + +- Add missing files to dist tarball (cqi) +- Tests for update command (cqi) +- Add support for module commands (mprahl) +- Clean rest cert related code (cqi) +- Remove fedora cert (cqi) +- Override build URL for Koji (cqi) +- changing anongiturl to use src.fp.o instead of pkgs.fp.o. - `#119`_ (tflink) +- Add tests (cqi) +- Enable lookaside_namespaced - `#130`_ (cqi) +- Detect dist tag correctly for RHEL and CentOS - `#141`_ (cqi) +- Remove deprecated call to platform.dist (cqi) +- Do not prompt hint for SSL cert if fail to log into Koji (cqi) +- Add more container-build options to bash completion (cqi) +- Remove osbs from bash completion - `#138`_ (cqi) +- Install executables via entry_points - `#134`_ (cqi) +- Fix container build target (lsedlar) +- Get correct build target for rawhide containers (lsedlar) +- Update error message to reflect deprecation of --dist option (pgier) + +.. _`#119`: https://pagure.io/rpkg/issue/119 +.. _`#130`: https://pagure.io/rpkg/issue/130 +.. _`#134`: https://pagure.io/rpkg/issue/134 +.. _`#138`: https://pagure.io/rpkg/issue/138 +.. _`#141`: https://pagure.io/rpkg/issue/141 diff --git a/doc/source/releases/1.31.rst b/doc/source/releases/1.31.rst new file mode 100644 index 0000000..e95e0a0 --- /dev/null +++ b/doc/source/releases/1.31.rst @@ -0,0 +1,25 @@ +.. _release_1.31: + +fedpkg 1.31 Release Notes +========================= + +Released on *January 22, 2018* + +Python compatibility +-------------------- + +fedpkg works with Python 2.6, 2.7 and 3.6. + +Change Logs +----------- + +- Include missing conf file in test (cqi) +- Add more document to request-repo and request-branch (cqi) +- Stop allowing EPEL branches on official EL packages (mprahl) +- Port fedrepo-req and fedrepo-req-branch to fedpkg (mprahl) +- Fix test for unsupported Bodhi version (lsedlar) +- Work with Bodhi 3 - `rhbz#1507410`_ (lsedlar) +- Allow any parameters in construct_build_url (cqi) +- Fix the anongiturl (patrick) + +.. _`rhbz#1507410`: https://bugzilla.redhat.com/show_bug.cgi?id=1507410 diff --git a/doc/source/releases/1.32.rst b/doc/source/releases/1.32.rst new file mode 100644 index 0000000..d9333ca --- /dev/null +++ b/doc/source/releases/1.32.rst @@ -0,0 +1,28 @@ +.. _release_1.32: + +fedpkg 1.32 Release Notes +========================= + +Released on *April 1, 2018* + +Python compatibility +-------------------- + +fedpkg works with Python 2.6, 2.7 and 3.6. + +Change Logs +----------- + +- Add requests-tests-repo command (mvadkert) +- Use PDC instead of Bodhi to get the active release branches - `#187`_ (mprahl) +- fix broken syntax in bash completion (tmz) +- Fix Python 3 incompatible code in tests (cqi) +- Better mocking. Return different values for each new request. (rbean) +- Typofix. (rbean) +- Add docstrings. (rbean) +- Automatically request module for non-standard branches. (rbean) +- Refactor: parameterize the request_repo and request_branch functionality. + (rbean) +- Some additions to the gitignore file. (rbean) + +.. _`#187`: https://pagure.io/rpkg/issue/187 diff --git a/doc/source/releases/1.33.rst b/doc/source/releases/1.33.rst new file mode 100644 index 0000000..f7aad47 --- /dev/null +++ b/doc/source/releases/1.33.rst @@ -0,0 +1,37 @@ +.. _release_1.33: + +fedpkg 1.33 Release Notes +========================= + +Released on *May 14, 2018* + +Python compatibility +-------------------- + +fedpkg works with Python 2.6, 2.7 and 3.6. + +Change Logs +----------- + +- Allow running tests against specified rpkg (cqi) +- Fix test due to rpkg uses getpass.getuser (cqi) +- Getting bodhi version works with Python 3 - `#213`_ (cqi) +- Detect Bodhi client by major version - `#204`_ (cqi) +- Allow requesting modular repositories without bug ID - `#197`_ (rdossant) +- Fix test test_verify_sls_invalid_date - `#209`_ (cqi) +- Copy pip-pycurl to ensure pycurl is installed correctly (cqi) +- Fix unicode issue for update command in Python 3 - `#206`_ (cqi) +- Fix a few E722 code styles errors (cqi) +- Fix fake PDC URL in test (cqi) +- Use tox to run tests with multiple Python versions (cqi) +- Reword error message for missing pagure token - `#194`_ (cqi) +- Tell which token ACL is required for request-repo - `#195`_ (cqi) +- Rename incorrect references of Koshei to be Anitya (mprahl) + +.. _`#194`: https://pagure.io/rpkg/issue/194 +.. _`#195`: https://pagure.io/rpkg/issue/195 +.. _`#197`: https://pagure.io/rpkg/issue/197 +.. _`#204`: https://pagure.io/rpkg/issue/204 +.. _`#206`: https://pagure.io/rpkg/issue/206 +.. _`#209`: https://pagure.io/rpkg/issue/209 +.. _`#213`: https://pagure.io/rpkg/issue/213 diff --git a/doc/source/releases/1.34.rst b/doc/source/releases/1.34.rst new file mode 100644 index 0000000..4ea2cb3 --- /dev/null +++ b/doc/source/releases/1.34.rst @@ -0,0 +1,139 @@ +.. _release_1.34: + +fedpkg 1.34 Release Notes +========================= + +Released on *July 19, 2018* + +This release requires ``rpkg >= 1.55``. + +Python compatibility +-------------------- + +fedpkg works with Python 2.6, 2.7 and 3.6. + +What's new in fedpkg 1.34 +------------------------- + +OIDC authentication is enabled via HTTPS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +OIDC authentication is enabled to let you push local changes to dist-git via +HTTPS. That means you don't have to request SSH permission to contribute to +a package. + +Command ``override`` to operate Bodhi update +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This new command has two subcommands to create and extend expiration +individually. + +An update could be created from a repository by generating build NVR from +current active release branch, or outside a repository by providing the NVR +explicitly. + +To create an update inside a repository, ensure switch to a release branch, +e.g. f28:: + + fedpkg override create + +To create an update outside a repository:: + + fedpkg override create foo-0.1-1.fc28 + +By default, update created from fedpkg has 7 days to be alive. ``--duration`` +could be used to change this default number of days. + +The expiration date of created update could be expanded by subcommand +``extend``:: + + fedpkg override extend 5 foo-0.1-1.fc28 + +This command extends update of build ``foo-0.1-1.fc28`` by 5 days. + +Please refer to man page for details. + +.. note:: + + fedpkg works with ``bodhi-client >= 2.0`` only. + +Pass repository name to ``request-repo`` explicitly +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Previously the new repository name, aka the package, module, or container name, +to be requested is specified by a global option ``--module-name`` (which is +deprecated already since rpkg-1.55). There were several issues reported for +that because it would confuse packagers easily with the word "module". To Avoid +the confusion, command ``request-repo`` has a new argument name to specify +repository name for clarity and optional ``--namespace`` option to indicate +namespace for the repository. + +Here is an example to request a RPM package ``foo`` with package review bug ID +``123456``:: + + fedpkg request-repo foo 123456 + +Another example to request a module ``bar``:: + + fedpkg request-repo --namespace modules bar + +.. warning:: + + Original form ``fedpkg --module-name foo request-repo`` is not supported. + Please switch to the new command form. + +Optional repository name and namespace to ``request-branch`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Command ``request-branch`` now has its own option ``--repo`` and +``--namespace`` to make it easy to use and avoid any potential confusion. +You can request a branch like this way:: + + fedpkg request-branch --repo foo f28 + +If ``--namespace`` is not specified, it defaults to ``rpms``. In order to +request a branch for non-RPM stuff, it accepts specific dist-git namespace like +namespace option in other commands. Here is an example to request a branch for +a module:: + + fedpkg request-branch --repo bar --namespace modules 10 + +.. note:: + + Global option ``--name`` and ``--namespace`` are usable for + ``request-branch``. However, it is recommended to use new options instead for + clarity. + +Change Logs +----------- + +* Get csrf token properly when retry bodhi API call (cqi) +* Accept old config with module instead of repo (lsedlar) +* Add option --namespace to command request-branch (cqi) +* Add argument name and option --namespace to request-repo - `#193`_ `#200`_ (cqi) +* Add explicit option --repo for request-branch - `#244`_ (cqi) +* Do not use deprecated option module-name (cqi) +* Remove compatible code with EL5 in bash completion (cqi) +* Handle Bodhi login automatically (cqi) +* Refine command override create (cqi) +* request-repo: Fix API token help text - `#232`_ (tmz) +* Use base_module in clone_config - `#230`_ (tmz) +* Extend override by number of days or specific date - `#67`_ (cqi) +* Use refactored man from pyrpkg (puiterwijk) +* Add new command for creating override in Bodhi - `#92`_ (cqi) +* Also remove bodhi url from config (cqi) +* Check bodhi version earlier (cqi) +* Drop support of bodhi-client 0.9 - `#223`_ (cqi) +* Use custom ArgumentParser from pyrpkg.cli (jkucera) +* Add OIDC config (puiterwijk) +* Fix argparse error in Python 3 - `#221`_ (cqi) + +.. _`#67`: https://pagure.io/rpkg/issue/67 +.. _`#92`: https://pagure.io/rpkg/issue/92 +.. _`#193`: https://pagure.io/rpkg/issue/193 +.. _`#200`: https://pagure.io/rpkg/issue/200 +.. _`#221`: https://pagure.io/rpkg/issue/221 +.. _`#223`: https://pagure.io/rpkg/issue/223 +.. _`#230`: https://pagure.io/rpkg/issue/230 +.. _`#232`: https://pagure.io/rpkg/issue/232 +.. _`#244`: https://pagure.io/rpkg/issue/244 diff --git a/fedpkg/cli.py b/fedpkg/cli.py index b31c9f2..11b1a93 100644 --- a/fedpkg/cli.py +++ b/fedpkg/cli.py @@ -124,9 +124,9 @@ the package foo: fedpkg request-repo name 1234 -Request a module with namespace explicitly: +Another example to request a module foo: - fedpkg --namespace modules request-repo foo + fedpkg request-repo --namespace modules foo '''.format(self.name, urlparse(self.config.get( '{0}.pagure'.format(self.name), 'url')).netloc) @@ -273,7 +273,10 @@ directory to package repository: request_branch_parser.set_defaults(command=self.request_branch) def register_override(self): - """Register command line parser for subcommand override""" + """Register command line parser for subcommand override + + .. versionadded:: 1.34 + """ def validate_duration(value): try: diff --git a/setup.py b/setup.py index be0140b..7197362 100755 --- a/setup.py +++ b/setup.py @@ -36,7 +36,7 @@ if ver[0] <= 2 and ver[1] < 7: setup( name="fedpkg", - version="1.33", + version="1.34", author="Dennis Gilmore", author_email="dgilmore@fedoraproject.org", description=("Fedora plugin to rpkg to manage "