Added collection version to title; Added dev suffix to version

Details: * Added the full version of the collection to its title. * Added support in the version parsing function in setup.py and in conf.py to accept preliminary versions according to the syntax defined by semver 2.0 which is allowed by Ansible, e.g. 1.0.0-dev1. This included monkey-patching the function that normalizes the version so it accepts semver compatible dev suffixes as required by Ansible. * Adjusted the instructions for releasing a version and for starting a new version in the development section of the docs to support development version suffixes. * Changed the version back to 1.0.0-dev1. Signed-off-by: Andreas Maier <maiera@de.ibm.com>
zhmcclient · Nov 12, 2020 · 9fddb75 · 9fddb75
1 parent b993cdf
commit 9fddb75
Show file tree

Hide file tree

Showing 28 changed files with 121 additions and 99 deletions.
diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Contributing &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>Contributing &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -107,7 +107,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.0.0',
+    VERSION: '1.0.0-dev1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/all_modules.html b/docs/all_modules.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>All modules &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>All modules &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -117,7 +117,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 

diff --git a/docs/appendix.html b/docs/appendix.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Appendix &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>Appendix &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -111,7 +111,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 

diff --git a/docs/changes.html b/docs/changes.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Change log &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>Change log &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -50,7 +50,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -113,7 +113,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 

diff --git a/docs/development.html b/docs/development.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Development &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>Development &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -112,7 +112,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 
@@ -284,12 +284,10 @@
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>vi galaxy.yml
 </pre></div>
 </div>
-<p>and verify that the version is set to the version to be released:</p>
+<p>and set the ‘version’ parameter to the version to be released:</p>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>version: M.N.U
 </pre></div>
 </div>
-<p>Note: The version in galaxy.yml cannot have a suffix of “.devX”, so it
-should already have had the version to be released.</p>
 </li>
 <li><p>Commit your changes and push them upstream:</p>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>git add docs_source/changes.rst
@@ -454,10 +452,14 @@
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>vi galaxy.yml
 </pre></div>
 </div>
-<p>and update the version to the new version:</p>
-<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>version: M.N.U
+<p>and update the version to the new version plus ‘-dev1’ to indicate it is in
+development:</p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>version: M.N.U-dev1
 </pre></div>
 </div>
+<p>Note: The version must follow the rules for semantic versioning 2.0 including
+the description of development/alpha/etc suffixes, as described in
+<a class="reference external" href="https://semver.org/">https://semver.org/</a></p>
 </li>
 <li><p>Commit your changes and push them upstream:</p>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>git add docs/changes.rst

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>Index &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -49,7 +49,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -102,7 +102,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 

diff --git a/docs/index.html b/docs/index.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>ibm.zhmc Ansible Galaxy collection &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -50,7 +50,7 @@
 
 
 
-            <a href="#" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="#" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -103,7 +103,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="#">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="#">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 
@@ -134,7 +134,7 @@
 
       <li><a href="#" class="icon icon-home"></a> &raquo;</li>
 
-      <li>ibm.zhmc Ansible Galaxy collection</li>
+      <li>ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</li>
 
 
       <li class="wy-breadcrumbs-aside">
@@ -151,8 +151,8 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <div class="section" id="ibm-zhmc-ansible-galaxy-collection">
-<h1>ibm.zhmc Ansible Galaxy collection<a class="headerlink" href="#ibm-zhmc-ansible-galaxy-collection" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="ibm-zhmc-ansible-galaxy-collection-release">
+<h1>ibm.zhmc Ansible Galaxy collection 1.0.0-dev1<a class="headerlink" href="#ibm-zhmc-ansible-galaxy-collection-release" title="Permalink to this headline">¶</a></h1>
 <div class="toctree-wrapper compound" id="mastertoc">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul>

diff --git a/docs/intro.html b/docs/intro.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Introduction &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>Introduction &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="All modules" href="all_modules.html" />
-    <link rel="prev" title="ibm.zhmc Ansible Galaxy collection" href="index.html" /> 
+    <link rel="prev" title="ibm.zhmc Ansible Galaxy collection 1.0.0-dev1" href="index.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -51,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -120,7 +120,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 
@@ -467,7 +467,7 @@ <h3>Verification of the installation<a class="headerlink" href="#verification-of
 </div>
 <div class="section" id="versioning">
 <span id="id6"></span><h2>Versioning<a class="headerlink" href="#versioning" title="Permalink to this headline">¶</a></h2>
-<p>This documentation applies to version 1.0.0 of the ibm.zhmc
+<p>This documentation applies to version 1.0.0-dev1 of the ibm.zhmc
 Ansible Galaxy collection.</p>
 <p>This collection uses the rules of <a class="reference external" href="http://semver.org/spec/v2.0.0.html">Semantic Versioning 2.0.0</a> for its version.</p>
 <p>This documentation may have been built from a development level of the
@@ -517,7 +517,7 @@ <h3>Verification of the installation<a class="headerlink" href="#verification-of
         <a href="all_modules.html" class="btn btn-neutral float-right" title="All modules" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="index.html" class="btn btn-neutral float-left" title="ibm.zhmc Ansible Galaxy collection" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="index.html" class="btn btn-neutral float-left" title="ibm.zhmc Ansible Galaxy collection 1.0.0-dev1" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

diff --git a/docs/modules/zhmc_adapter.html b/docs/modules/zhmc_adapter.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>zhmc_adapter – Manages adapters of Z systems. &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>zhmc_adapter – Manages adapters of Z systems. &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="../index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="../index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -128,7 +128,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="../index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 

diff --git a/docs/modules/zhmc_cpc.html b/docs/modules/zhmc_cpc.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>zhmc_cpc – Manages Z systems at the system level. &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>zhmc_cpc – Manages Z systems at the system level. &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="../index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="../index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -128,7 +128,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="../index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>
 

diff --git a/docs/modules/zhmc_crypto_attachment.html b/docs/modules/zhmc_crypto_attachment.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>zhmc_crypto_attachment – Manages the attachment of crypto resources to partitions of Z systems. &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
+  <title>zhmc_crypto_attachment – Manages the attachment of crypto resources to partitions of Z systems. &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0-dev1 1.0.0-dev1 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="../index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
+            <a href="../index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection 1.0.0-dev1
 
 
 
@@ -128,7 +128,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">ibm.zhmc Ansible Galaxy collection</a>
+          <a href="../index.html">ibm.zhmc Ansible Galaxy collection 1.0.0-dev1</a>
 
       </nav>