Changes between Version 33 and Version 34 of DevGuide

Timestamp:

Apr 15, 2021, 11:10:48 AM (3 years ago)

Author:

Cinc-th

Comment:

Described which version to chose for a plugin. Described development/release cycle.

DevGuide

@@ -97 +97 @@
 If your plugin ships with other code, such as jQuery or a Python library, then mention this in your plugin description.
 
+== Version of your plugin
+
+You should use the {{{major.minor.micro}}} semantic versioning scheme also used by [trac:TracDev/ReleaseChecklist#Versionidentification Trac (version identification)]. ​Some additional guidance can be found in PEP:0440.
+
+In the event that a defect or packaging distribution error is discovered after a release is made, the ''micro'' version number should be incremented and a new minor release created. Note that a filename cannot be reused when uploading to PyPI ​more than once, so the ''micro'' version must also be incremented in the event of a packaging or uploading error.
+
+Development releases are created directly from the current source. These are not uploaded to PyPI and usually done by the user to get the latest snapshot. To distinguish them from final releases a {{{dev}}} suffix should be added. This can be done for you by creating a {{{setup.cfg}}} file in the same directory where {{{setup.py}}} is located with the following contents.
+{{{#!ini
+[egg_info]
+tag_build = dev
+}}}
+
+=== Development cycle
+The proposed development and release cycle is described here. The current final version is {{{1.0.1}}}. The next planned release version is {{{1.2.0}}}.
+
+1. In {{{setup.py}}} specify the next version:
+   {{{#!python
+setup(
+    name='YourPluginsName',
+    version='1.2.0',
+[...]
+     )
+   }}}
+1. in {{{setup.cfg}}} add the development tag as described before:
+   {{{#!ini
+[egg_info]
+tag_build = dev
+   }}}
+
+You may proceed with development now. Whenever a user is creating his own development release it will be marked like {{{YourPluginName-1.2.0.dev0-py3.8.egg}}}.
+
+When creating a release do the following:
+1. Temporarily remove the entry from {{{setup.cfg}}}:
+   {{{#!ini
+#[egg_info]
+#tag_build = dev
+   }}}
+1. Create a release version which will be named like {{{YourPluginName-1.2.0-py3.8.egg}}}. If you want to publish to PyPI see the Instructions below.
+1. After publishing the release version prepare the next development cycle by increasing the version number in {{{setup.py}}} and putting back the development tag in {{{setup.cfg}}}:
+   {{{#!python
+setup(
+    name='YourPluginsName',
+    # Note that the version number was changed from 1.2.0 to 1.3.0
+    # which will be the next release.
+    version='1.3.0',
+[...]
+     )
+   }}}
+   {{{#!ini
+   [egg_info]
+   tag_build = dev
+   }}}
+
 == Publishing Packages to PyPI