Add automated versioning (#5)

Author: JonZeolla

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+---
+name: "Release"
+
+on:
+  push:
+    tags:
+      - 'v2[0-1][0-9][0-9].0[0-9].[0-9][0-9]'
+      - 'v2[0-1][0-9][0-9].1[0-2].[0-9][0-9]'
+
+jobs:
+  distribute:
+    name: Distribute
+    runs-on: Ubuntu-20.04
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v2
+      - name: Publish the release to GitHub
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }} release
+          draft: false
+          prerelease: false

LICENSE

@@ -0,0 +1 @@
+Copyright (c) 2021-2021, Seiso, LLC - All rights reserved.

Pipfile

@@ -0,0 +1,11 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+bumpversion = "*"
+gitpython = "*"
+invoke = "*"

Pipfile.lock

@@ -18,22 +18,43 @@ cd $(ls -td * | head -1)
 grep -r TODO *
 
 # Add your code and tests
-...
+pipenv install --dev
+# ...
 
-# Commit and push your work
+# Commit and test your work
 git init --initial-branch=main
 git add -A
 git commit -m "Initial commit"
-
-# Do some final testing
-pipenv install --dev
 pipenv run invoke test
 
+# Make your first release
+git remote add origin git@github.com:SeisoLLC/$(basename $(pwd)).git
+git push origin $(git branch --show-current)
+
+###############################
+# CalVer
+pipenv run invoke release
+###############################
+# or
+###############################
+# SemVer
+pipenv run invoke release minor
+###############################
+
 # Ship it!
-git remote add origin git@github.com:SeisoLLC/TODO.git
-git push origin main
+git push --atomic origin $(git branch --show-current) $(git describe --tags)
+
+# Finally, setup your repo settings (setup a branch policy, enable dependabot, add docker hub secrets, etc...)
+```
+
+## Updating the dependencies
+```bash
+pipenv update
 ```
 
 ## FAQs
 Q: Why am I getting `invalid reference format: repository name must be lowercase` when I try to build my docker container?  
 A: You customized the `project_slug` when answering the `cookiecutter` questions and included a capital letter. Don't do that!  
+
+Q: What does `SemVer-ish` mean?
+A: Docker isn't compatible with SemVer, as it doesn't allow `+` symbols in their tags (which are used by Semver to indicate builds). As a workaround, we use `-`s instead (only for local builds, not official releases), which is not compliant with the official SemVer spec, but is easily human understandable. In order to keep the docker image tags in line with git tags, both use this SemVer-like notation.

README.md

@@ -0,0 +1,6 @@
+# Reporting Security Issues
+Seiso and the cookiecutter-python community take security seriously, and appreciate all efforts that disclose concerns responsibly.
+
+If you believe you've found a security bug in our project, please contact us at [security@SeisoLLC.com](mailto:security@SeisoLLC.com) and include the words "cookiecutter-python vulnerability" in the subject line. If you believe you've found a security bug in a third-party project used by cookiecutter-python, please report it to those those maintainers.
+
+Your email will be acknowledged within one business day, and you'll receive a more detailed response to your email as soon as possible indicating the next steps in handling your report. After the initial reply to your report, we will endeavor to keep you informed of the progress being made towards a fix and announcement.

SECURITY.md

@@ -4,6 +4,6 @@
   "project_short_description": "TODO",
   "project_owner_github_username": "jonzeolla",
   "dockerhub": "y",
-  "versioning": ["SemVer", "CalVer"],
+  "versioning": ["CalVer", "SemVer-ish"],
   "license": ["MIT", "BSD-3", "Not open source"]
 }

cookiecutter.json

@@ -0,0 +1,18 @@
+[bumpversion]
+current_version = 2021.02.01
+parse = (?P<year>2[0-1]\d{2})\.(?P<month>(0\d|1[0-2]))(.(?P<increment>\d{2}))?
+serialize = {year}.{month}.{increment}
+commit_message = "Automatically generated release {new_version}"
+commit = True
+tag = True
+push = True
+
+[metadata]
+author = 'Seiso'
+description = 'The Seiso standard python cookiecutter template'
+description-file = 'README.md'
+license_file = 'LICENSE'
+name = 'cookiecutter-python'
+url = 'https://github.com/SeisoLLC/cookiecutter-python'
+
+[bumpversion:file:setup.cfg]

setup.cfg

@@ -0,0 +1,68 @@
+#!/usr/bin/env python3
+"""
+Task execution tool & library
+"""
+
+import json
+import re
+import sys
+from datetime import datetime
+from logging import basicConfig, getLogger
+from pathlib import Path
+
+import git
+from bumpversion.cli import main as bumpversion
+from invoke import task
+
+LOG_FORMAT = json.dumps(
+    {
+        "timestamp": "%(asctime)s",
+        "namespace": "%(name)s",
+        "loglevel": "%(levelname)s",
+        "message": "%(message)s",
+    }
+)
+basicConfig(level="INFO", format=LOG_FORMAT)
+LOG = getLogger("cookiecutter-python")
+
+CWD = Path(".").absolute()
+REPO = git.Repo(CWD)
+
+
+# Tasks
+@task
+def test(c):  # pylint: disable=unused-argument
+    """Test cookiecutter-python"""
+    LOG.warning("TODO: Implement tests")
+
+
+@task(pre=[test])
+def release(c):  # pylint: disable=unused-argument
+    """Make a new release of cookiecutter-python"""
+    if REPO.head.is_detached:
+        LOG.error("In detached HEAD state, refusing to release")
+        sys.exit(1)
+
+    # Get the current date info
+    date_info = datetime.now().strftime("%Y.%m")
+
+    # Our CalVer pattern which works until year 2200, up to 100 releases a
+    # month (purposefully excludes builds)
+    pattern = re.compile(r"v2[0-1][0-9]{2}.(0[0-9]|1[0-2]).[0-9]{2}")
+
+    # Identify and set the increment
+    for tag in reversed(REPO.tags):
+        if pattern.fullmatch(tag.name):
+            latest_release = tag.name
+            break
+    else:
+        latest_release = None
+
+    if latest_release and date_info == latest_release[:7]:
+        increment = str(int(latest_release[8:]) + 1).zfill(2)
+    else:
+        increment = "01"
+
+    new_version = date_info + "." + increment
+
+    bumpversion(["--new-version", new_version, "unusedpart"])

tasks.py

@@ -10,5 +10,5 @@
 ## Your environment
 
 
-## Logs, errors, etc.
+## Logs and error messages
 

{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,4 @@
+---
+rules:
+  # Workaround until replicatedhq/dockerfilelint#169 is resolved
+  missing_tag: off

{{cookiecutter.project_slug}}/.github/linters/.dockerfilelintrc

@@ -0,0 +1,5 @@
+---
+ignored:
+  # Workaround: added an environment variable of PIP_NO_CACHE_DIR=1 in the
+  # Dockerfile
+  - DL3042

{{cookiecutter.project_slug}}/.github/linters/.hadolint.yml

@@ -1,18 +1,20 @@
 ---
 name: "Commit"
+
 on:
   push:
     branches:
       - main
+
 jobs:
   test:
-    name: Test the project
+    name: Test
     runs-on: Ubuntu-20.04
     strategy:
       matrix:
         python-version:
-          - '3.8'
-          - '3.9'
+          - 3.8
+          - 3.9
     steps:
       - name: Checkout the repo
         uses: actions/checkout@v2
@@ -28,43 +30,34 @@ jobs:
           pipenv install --python ${{ "{{ matrix.python-version }}" }} --dev
       - name: Run the tests
         run: pipenv run invoke test
-{% if cookiecutter.dockerhub == 'y' -%}
-  push:
-    name: Build and push the Docker images
+{%- if cookiecutter.dockerhub == 'y' %}
+  distribute:
+    name: Distribute
     runs-on: Ubuntu-20.04
-    strategy:
-      matrix:
-        python-version:
-          - '3.9'
     needs: test
     steps:
       - name: Checkout the repo
         uses: actions/checkout@v2
       - name: Setup python
         uses: actions/setup-python@v2
         with:
-          python-version: ${{ "{{ matrix.python-version }}" }}
+          python-version: 3.9
       - name: Install the dependencies
         run: |
           python -m pip install --upgrade pipenv
-          pipenv install --python ${{ "{{ matrix.python-version }}" }} --dev
-      - name: Build the docker image
-        run: pipenv run invoke build
+          pipenv install --dev
       - name: Login to Docker Hub
         uses: docker/login-action@v1
         with:
           username: ${{ "{{ secrets.DOCKERHUB_USERNAME }}" }}
           password: ${{ "{{ secrets.DOCKERHUB_TOKEN }}" }}
       - name: Publish the README
-        uses: christian-korneck/update-container-description-action@d36005551adeaba9698d8d67a296bd16fa91f8e8
-        env:
-          DOCKER_USER: ${{ "{{ secrets.DOCKERHUB_USERNAME }}" }}
-          DOCKER_PASS: ${{ "{{ secrets.DOCKERHUB_TOKEN }}" }}
+        uses: peter-evans/dockerhub-description@v2
         with:
-          destination_container_repo: seiso/{{ cookiecutter.project_slug }}
-          provider: dockerhub
-          short_description: {{ cookiecutter.project_short_description }}
-          readme_file: README.md
-      - name: Publish the latest image
+          username: ${{ "{{ secrets.DOCKERHUB_USERNAME }}" }}
+          password: ${{ "{{ secrets.DOCKERHUB_TOKEN }}" }}
+          repository: seiso/{{ cookiecutter.project_slug }}
+          short-description: {{ cookiecutter.project_short_description }}
+      - name: Publish the latest docker image
         run: pipenv run invoke publish latest
 {%- endif -%}

{{cookiecutter.project_slug}}/.github/workflows/commit.yml

@@ -1,18 +1,20 @@
 ---
 name: "PR"
+
 on:
   pull_request:
     branches:
       - main
+
 jobs:
   test:
-    name: Test the project
+    name: Test
     runs-on: Ubuntu-20.04
     strategy:
       matrix:
         python-version:
-          - '3.8'
-          - '3.9'
+          - 3.8
+          - 3.9
     steps:
       - name: Checkout the repo
         uses: actions/checkout@v2