From 3302e04bfb7303a9143ce60483818dea24e1b004 Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Thu, 24 Sep 2015 11:47:47 -0400 Subject: [PATCH] Switch to using autogenerated ChangeLog in docs This commit switches the docs to use the PBR generated ChangeLog instead of a hand curated release notes section. This is a lot less error prone and instantaneous as compared to our current method which often leaves the release notes section stale for months at a time. Change-Id: If7354fc0612ed6d4dd76c8c595ba4722367fe65e --- README.rst | 110 ----------------------------------------- doc/source/history.rst | 1 + doc/source/index.rst | 1 + 3 files changed, 2 insertions(+), 110 deletions(-) create mode 100644 doc/source/history.rst diff --git a/README.rst b/README.rst index d28c05e..bf58b45 100644 --- a/README.rst +++ b/README.rst @@ -113,113 +113,3 @@ along with any options that you would normally use to either specify a config file or the DB connection info. Running this command will print to stdout the subunit v2 stream for the run specified by $RUN_ID, unless the --out_path argument is specified to write it to a file instead. - -Release Notes -============= - -0.8.1 ------ - * Fix an issue with migration 1ff737bef438 which was failing on creating an - index on mysql environments using multi-byte utf8. - -0.8.0 ------ - * DB API improvements: - * New methods to get runs by key value pair in run_metadata and get - the run_metadata for a run - * Documentation updates - * A new migration is added to add additional indexes on common search - patterns - * Several bugfixes and code cleanups - - -0.7.0 ------ - * Initial external plugin support for the subunit2sql-graph command - * Internal code cleanup around the use of the oslo namespace package - * A temporary version cap on oslo.db limiting it to < 2.0.0 because of a - subunit2sql dependency on an internal oslo.db interface (this will be removed - in a future release) - -0.6.0 ------ - * subunit2sql-graph improvements: - * Use setuptools extras to list graph requirements - * Adds documentation - * New graph type to show daily test count over time - * Graph cleanups - * Start of attachments support - * Adds a new table to store arbitrary attachments from a subunit stream - * Support to the subunit2sql utility to store attachments in the attachments - table - -0.5.1 ------ -* Remove matplotlib from requirements file to avoid requiring additional C - dependencies in CI systems. (the next release will switch to using extras - to articulate the additional dependencies for the graphing tool) - -0.5.0 ------ - * Several new db api methods to: - * Delete old runs and test_runs - * Get a test status time series dict - * Get a test uuid from a test_id - * Get date bounded per status counts for a test - * Adds a new subunit2sql-db-manage subcommand to expire runs and - test_runs - * Reworked subunit2sql-graph command to be modular extendable - * Added 2 new graph types to subunit2sql-graph, agg_count and failures - * Improved the formatting for the previously existing run_time graph - -0.4.2 ------ - * Fixes an issue with the path finding in 1679b5bc102 which cause failures - when running the migration from an installed version of subunit2sql - -0.4.1 ------ - * Fixes an issue with running the 1679b5bc102 DB migration on large mysql - databases running on trove by hand coding the SQL for running on MySQL - -0.4.0 ------ - * Add a new tool, subunit2sql-graph, for graphing a test's run_time over time - * Fix to ensure attrs are set in the output from sql2subunit - * Add a new DB migration to separate microseconds for start and stop time in - the test_runs table into separate columns - * Add db api methods to get a time series of run_times for a specific test, - to update an existing test_run row, and methods to get a list of recent run - uuids - * Several miscellaneous bug fixes - -0.3.0 ------ - * Add new db api methods to extract more test information from a given run - * Add a --average flah to sql2subunit for using the aggregate test data in - the tests table to write a subunit stream - * Bug and performance fixes around the sql2subunit command - * Documentation updates - -0.2.1 ------ - * Documentation Improvements - * Fixed the output from the --version flag - * Added an option to set the run_id when adding a new run to the db - * Several code cleanups - -0.2.0 ------ - * Adds 2 new commands sql2subunit, and subunit2sql-db-manage - * Migration Testing improvements - * Drops the state_path config option which was unused - * Added sample config files and a method for generating up to date copies - * Adds a migration to add a run_at column to the runs table - * Adds a migration to populate the run_time column in the tests table for - rows that do not have a value there - * Several bug fixes and code cleanups - - -0.1 ---- - * First release diff --git a/doc/source/history.rst b/doc/source/history.rst new file mode 100644 index 0000000..69ed4fe --- /dev/null +++ b/doc/source/history.rst @@ -0,0 +1 @@ +.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index f7a0985..cf6fac1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,6 +11,7 @@ Contents: data_model api graph + history ==================