Prepare v01 release, add towncrier (#73)

* Add towncrier
* Patch install script
* Add release stage to CI (temporarily disabled)

azure-pipelines.yml

@@ -1,52 +1,89 @@
 trigger:
-  - master
-  - development
+  branches:
+    include:
+      - master
+      - development
+  tags:
+    include:
+    - v*
 
 pr:
   branches:
     include:
     - '*'
 
-jobs:
-# QA
-- job: lint
-  pool:
-    vmImage: 'ubuntu-16.04'
-  steps:
-  - template: ci/lint.yml
+stages:
+- stage: Build
+  jobs:
+  # QA
+  - job: lint
+    pool:
+      vmImage: 'ubuntu-16.04'
+    steps:
+    - template: ci/lint.yml
+
+  # Build
+  # Linux
+  # TODO: Turn off Linux Testing until https://github.com/sdispater/poetry/issues/1197 is resolved
+  # - job: test_linux
+  #   dependsOn: lint
+  #   pool:
+  #     vmImage: 'ubuntu-16.04'
+  #   strategy:
+  #     matrix:
+  #       Python36:
+  #         python.version: '3.6'
+  #   steps:
+  #   - bash: |
+  #       sudo apt update
+  #       sudo apt install swig3.0
+  #       sudo ln -s /usr/bin/swig3.0 /usr/bin/swig
+  #     displayName: Install swig on Linux
+  #   - template: ci/install.yml
+  #   - template: ci/tests.yml
 
-# Linux
-# TODO: Turn off Linux Testing until https://github.com/sdispater/poetry/issues/1197 is resolved
-# - job: install_linux
-#   dependsOn: lint
-#   pool:
-#     vmImage: 'ubuntu-16.04'
-#   strategy:
-#     matrix:
-#       Python36:
-#         python.version: '3.6'
-#   steps:
-#   - bash: |
-#       sudo apt update
-#       sudo apt install swig3.0
-#       sudo ln -s /usr/bin/swig3.0 /usr/bin/swig
-#     displayName: Install swig on Linux
-#   - template: ci/install.yml
-#   - template: ci/tests.yml
+  #MacOS
+  - job: test_macos
+    dependsOn: lint
+    pool:
+      vmImage: 'macOS-10.13'
+    strategy:
+      matrix:
+        Python36:
+          python.version: '3.6'
+    steps:
+    - script: |
+        brew install swig
+        brew install gcc@5
+      displayName: Install Brew packages
+    - template: ci/install.yml
+    - template: ci/tests.yml
 
-#MacOS
-- job: install_macos
-  dependsOn: lint
-  pool:
-    vmImage: 'macOS-10.13'
-  strategy:
-    matrix:
-      Python36:
-        python.version: '3.6'
-  steps:
-  - script: |
-      brew install swig
-      brew install gcc@5
-    displayName: Install Brew packages
-  - template: ci/install.yml
-  - template: ci/tests.yml
+# TODO: switch to linux box release when the above is fixed
+# - stage: Release
+#   condition: contains(variables['Build.SourceBranch'], 'tags')
+#   jobs:
+#   - job: release
+#     pool:
+#       vmImage: 'macOS-10.13'
+#     steps:
+#     - task: UsePythonVersion@0
+#       inputs:
+#         versionSpec: '3.6'
+#       displayName: Select Python version
+#     - script: |
+#         brew install swig
+#         brew install gcc@5
+#       displayName: Install Brew packages
+#     - template: ci/install.yml
+#     - script: $HOME/.poetry/bin/poetry build
+#         $HOME/.poetry/bin/poetry publish -u $(pypi_username) -p $(pypi_password)
+#       displayName: Release to pypi
+#     - task: GitHubRelease@0
+#       inputs:
+#         gitHubConnection: georgianpartners
+#         repositoryName: georgianpartners/foreshadow
+#         tagSource: 'auto'
+#         assets:
+#           dist/*
+#       displayName: Add release to GitHub

doc/changelog.rst

@@ -1,8 +1,3 @@
 .. _changelog:
 
-Changelog
-=========
-
-v0.1
-^^^^
-- Initial Release
+.. towncrier release notes start

newsfragments/.gitignore

@@ -0,0 +1 @@
+!.gitignore

newsfragments/71.feature

@@ -0,0 +1 @@
+Initial release.

pyproject.toml

@@ -65,6 +65,7 @@ seed-isort-config = "^1.7"
 sphinx = "^1.7.6"
 sphinx_rtd_theme = "^0.4.1"
 sphinxcontrib-plantuml = "^0.16.1"
+towncrier = "^19.2"
 tox = "^3.9.0"
 wily = {version = "^1.12", python = "^3.6"}
 xdoctest = "^0.8.1"
@@ -113,6 +114,17 @@ force_grid_wrap = 0
 combine_as_imports = true
 include_trailing_comma = true
 
+[tool.towncrier]
+# Usage: (Source: https://github.com/python-trio/trio/blob/master/pyproject.toml)
+# - PRs should drop a file like "issuenumber.feature" in newsfragments
+#   (or "bugfix", "doc", "removal", "misc"; misc gets no text, we can
+#    customize this)
+# - At release time after bumping version number, run:
+#   poetry run towncrier --draft, then poetry towncrier
+package = "foreshadow"
+filename = "doc/changelog.rst"
+directory = "newsfragments"
+
 [build-system]
 requires = ["numpy>=1.16.1", "Cython>=0.29.5", "poetry>=0.12"]
 build-backend = "poetry.masonry.api"

scripts/macos.sh

@@ -92,9 +92,7 @@ source ~/.bash_profile
 poetry install -v
 
 # Install optional dependencies
-export CC=gcc-5
-export CXX=g++-5
-poetry install -v -E dev
+export CC=gcc-5; export CXX=g++-5; poetry install -v -E dev
 
 # Run tests
-pytest
+poetry run pytest