Merge pull request #33 from OpenDebates/public-release

Public Major Release

Author: vivekjoshy

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.2.0-beta.0
+current_version = 1.0.0
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+)\.(?P<build>\d+))?

CHANGELOG.rst

@@ -0,0 +1,13 @@
+All notable changes to this openskill.py will be documented in this file.
+
+This file is updated every release since v1.0.0 with the use of towncrier from the fragments found under changes/
+
+.. towncrier release notes start
+
+Openskill 1.0.0 (2022-02-04)
+============================
+
+Features
+--------
+
+- Capability to predict winners of match given a set of teams. (`#27 <https://github.com/OpenDebates/openskill.py/issues/27>`_)

docs/contributing.rst

@@ -11,6 +11,33 @@ All pull requests to the python source must follow `PEP 8 <https://www.python.or
 All methods and functions must be in snake_case and not camelCase. All code must also be formatted with ``black`` and it's default settings.
 
 
+Towncrier
+---------
+
+To aid with the generation of ``CHANGELOG.rst`` as well as the releases changelog we use towncrier.
+
+You will need to install towncrier and openskill.py from source before making changelog additions.
+
+.. code::
+
+    poetry install
+
+For every pull request made to this project, there should be a short explanation of the change under changes/ with the following format: ``{pull_request_number}.{type}.rst``,
+
+Possible types are:
+
+- breaking: Signifying a backwards incompatible change.
+- feature: Signifying a new feature.
+- bugfix: Signifying a bugfix.
+- doc: Signifying a documentation improvement.
+- deprecation: Signifying a deprecation or removal of public API.
+
+For changes that do not fall under any of the above cases, please specify the lack of the changelog in the pull request description so that a maintainer can skip the job that checks for newly added fragments.
+
+Best way to create the fragments is to run towncrier create ``{pull_request_number}.{type}.rst`` after creating the pull request, edit the created file and committing the changes.
+
+Multiple fragment types can be created per pull request if it covers multiple areas.
+
 Pull Requests
 -------------
 

openskill/__init__.py

@@ -2,4 +2,4 @@
 from openskill.rate import rate, Rating, create_rating, team_rating, predict_win
 
 
-__version__ = "0.2.0-beta.0"
+__version__ = "1.0.0"

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openskill"
-version = "0.2.0-beta.0"
+version = "1.0.0"
 description = "Python implementation of Weng-Lin Bayesian ranking, a better, license-free alternative to TrueSkill."
 authors = ["Taven <taven@outlook.in>"]
 license = "MIT"
@@ -56,10 +56,25 @@ furo = "^2022.1.2"
 jsonlines = "^3.0.0"
 prompt-toolkit = "^3.0.26"
 trueskill = "^0.4.5"
+towncrier = "^21.3.0"
 
 [tool.poetry.extras]
 docs = ["sphinx", "furo"]
 
+[tool.towncrier]
+package = "openskill"
+package_dir = "openskill"
+directory = "changes"
+filename = "CHANGELOG.rst"
+issue_format = "`#{issue} <https://github.com/OpenDebates/openskill.py/issues/{issue}>`_"
+type = [
+    { name = "Breaking Changes",            directory = "breaking",     showcontent = true },
+    { name = "Deprecation",                 directory = "deprecation",  showcontent = true },
+    { name = "Features",                    directory = "feature",      showcontent = true },
+    { name = "Bugfixes",                    directory = "bugfix",       showcontent = true },
+    { name = "Documentation Improvements",  directory = "doc",          showcontent = true },
+]
+
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = "-ra --strict-markers --ignore=docs/conf.py --ignore=setup.py --ignore=benchmark/benchmark.py --ignore=ci --ignore=.eggs --doctest-modules --doctest-glob=/*.rst --tb=short"