prepare 0.2

.matyan.ini

@@ -20,3 +20,5 @@ exact: more
        more on
        wip
        commit
+prefix: more on
+        continue on

README.rst

@@ -98,6 +98,12 @@ version 0.0.3.
 
     generate-changelog master..dev --show-releases
 
+**Generate changelog for the latest release with releases info shown**
+
+.. code-block:: sh
+
+    generate-changelog --latest-release --show-releases
+
 Configuration
 =============
 In order to customize names and texts, add a ``.matyan.ini`` in your
@@ -130,6 +136,9 @@ Sample configuration:
            more on
            wip
            commit
+    prefix: more on
+            continue on
+
 
 Tips and tricks
 ===============

TODOS.rst

@@ -5,11 +5,11 @@ TODOS
 + Add releases (group by releases) and actually, switch to releases and deprecate
   old system, since it's irrelevant. It's always desired to show changelog by 
   releases. Think about the first tree item - 'Unreleased'. The rest are tags.
-- Flexible regex patterns.
-- Add from and to (``generate-changelog 0.1..0.2``).
-- Make it possible to provide ignore patterns for commits and releases.
++ Add from and to (``generate-changelog 0.1..0.2``).
 + Add output to file. Documented how to write to file instead.
-- Add tests.
++ Add tests.
++ Create initial config file.
++ Add a command for generating the changelog for latest release.
+- Make it possible to provide ignore patterns for commits and releases.
+- Flexible regex patterns.
 - Make it possible to provide a template for generated changelog file.
-- Create initial config file.
-- Add a command for generating the changelog for latest release.

docs/documentation.rst.distrib

@@ -9,6 +9,7 @@ Contents:
 
    index
    basic_concepts
+   methodology
    changelog
    matyan
 

docs/methodology.rst

@@ -0,0 +1,20 @@
+Methodology
+===========
+- Protect your main (DTAP) branches from direct commits. Commits shall only
+  arrive into these branches via pull request.
+- Use feature branches. Make your own prefixes (or use current ones) for
+  classification of the ticket. Add ticket name to the name of the branch,
+  followed by slugified ticket title.
+- Prefix commits with ticket number followed by meaningful description.
+
+Sample branch names:
+
+- ``bugfix/MSFT-1240-LinkedIn-authentication-failing``
+- ``deprecation/MSFT-1239-Deprecate-Python2``
+- ``feature/MSFT-1238-Token-authentication``
+
+Sample commit messages:
+
+- ``MSFT-1240 Fix package configuration.``
+- ``MSFT-1239 Deprecate Python2.``
+- ``MSFT-1238 Implement token authentication.``

setup.py

@@ -6,7 +6,7 @@
 except:
     readme = ''
 
-version = '0.1'
+version = '0.2'
 
 setup(
     name='matyan',

src/matyan/.matyan.ini

@@ -20,3 +20,5 @@ exact: more
        more on
        wip
        commit
+prefix: more on
+        continue on

src/matyan/__init__.py

@@ -5,7 +5,7 @@
 )
 
 __title__ = 'matyan'
-__version__ = '0.0.2'
+__version__ = '0.2'
 __author__ = 'Artur Barseghyan'
 __copyright__ = '2019 Artur Barseghyan'
 __license__ = 'GPL-2.0-only OR LGPL-2.0-or-later'

src/matyan/labels.py

@@ -6,14 +6,15 @@
 __copyright__ = '2019 Artur Barseghyan'
 __license__ = 'GPL-2.0-only OR LGPL-2.0-or-later'
 __all__ = (
+    'get_all_branch_types',
     'get_branch_types',
+    'get_ignore_commits_exact_words',
+    'get_ignore_commits_prefixes',
     'get_other_branch_type',
-    'get_all_branch_types',
-    'get_unreleased',
     'get_other_branch_type_key',
+    'get_unreleased',
     'get_unreleased_key',
     'get_unreleased_key_label',
-    'get_ignore_commits_exact_words',
 )
 
 
@@ -75,3 +76,11 @@ def get_ignore_commits_exact_words() -> List[str]:
     :return:
     """
     return CONFIG['IgnoreCommits']['exact'].split('\n')
+
+
+def get_ignore_commits_prefixes() -> List[str]:
+    """Get ignore commits prefixes.
+
+    :return:
+    """
+    return CONFIG['IgnoreCommits']['prefix'].split('\n')

src/matyan/patterns.py

@@ -4,11 +4,11 @@
 __copyright__ = '2019 Artur Barseghyan'
 __license__ = 'GPL-2.0-only OR LGPL-2.0-or-later'
 __all__ = (
-    'REGEX_PATTERN_BRANCH_TYPE',
     'REGEX_PATTERN_BRANCH_NAME',
-    'REGEX_PATTERN_MERGED_BRANCH_NAME',
+    'REGEX_PATTERN_BRANCH_TYPE',
     'REGEX_PATTERN_COMMIT',
     'REGEX_PATTERN_COMMIT_LINE',
+    'REGEX_PATTERN_MERGED_BRANCH_NAME',
     'REGEX_PATTERN_TAG',
 )
 
@@ -48,4 +48,5 @@ def get_branch_types_for_regex() -> str:
                             REGEX_PATTERN_COMMIT + \
                             r'\s?(?P<commit_message>.*)'
 
+
 REGEX_PATTERN_TAG = r'(?P<tag>((\d{1,9}\.)+(\d)+))'

src/matyan/utils.py

@@ -12,20 +12,21 @@
 
 from .labels import (
     get_all_branch_types,
-    get_other_branch_type,
     get_branch_types,
-    get_unreleased,
+    get_ignore_commits_exact_words,
+    get_ignore_commits_prefixes,
+    get_other_branch_type,
     get_other_branch_type_key,
+    get_unreleased,
     get_unreleased_key,
     get_unreleased_key_label,
-    get_ignore_commits_exact_words,
 )
 from .helpers import project_dir
 from .patterns import (
     REGEX_PATTERN_BRANCH_NAME,
-    REGEX_PATTERN_MERGED_BRANCH_NAME,
     REGEX_PATTERN_COMMIT,
     REGEX_PATTERN_COMMIT_LINE,
+    REGEX_PATTERN_MERGED_BRANCH_NAME,
     REGEX_PATTERN_TAG,
 )
 
@@ -292,6 +293,10 @@ def prepare_changelog(
             if commit_message.lower() in IGNORE_COMMITS_EXACT_WORDS:
                 continue
 
+            for ignore_prefix in get_ignore_commits_prefixes():
+                if commit_message.lower().startswith(ignore_prefix):
+                    continue
+
             commit_hash = commit_message \
                 if unique_commit_messages \
                 else entry['commit_hash']
@@ -480,6 +485,10 @@ def prepare_releases_changelog(
             if commit_message.lower() in IGNORE_COMMITS_EXACT_WORDS:
                 continue
 
+            for ignore_prefix in get_ignore_commits_prefixes():
+                if commit_message.lower().startswith(ignore_prefix):
+                    continue
+
             commit_hash = commit_message \
                 if unique_commit_messages \
                 else entry['commit_hash']