Merge pull request #46 from zalando-incubator/release-all-merges

Release all master merges

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,20 +2,22 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: ''
+labels: 'bug'
 assignees: ''
 
 ---
 
 **Describe the bug**
-A clear and concise description of what the bug is.
+A clear and concise description of the problem.
+
+**Transformer version**
+Output of the command `transformer --version`.
 
 **To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+Steps and input files to reproduce the behavior:
+1. Create the file "..."
+2. Run Transformer with the arguments "..."
+3. See error
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
@@ -24,15 +26,8 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+ - OS: [e.g. Fedora, MacOS]
+ - Version: [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,18 +2,19 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: ''
+labels: 'enhancement'
 assignees: ''
 
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear and concise description of what the problem is.
+Example: I'm always frustrated when [...]
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Describe the solution you'd like.**
+A clear and concise description of what you would like to happen.
 
-**Describe alternatives you've considered**
+**Describe alternatives you've considered.**
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,10 @@
-# One-line summary
+One-line summary.
 
-> Issue : #1234 (only if appropriate)
+Closes #123 (number of the corresponding issue, only if appropriate).
 
 ## Description
 
-A few sentences describing the overall goals of the pull request's
-commits.
+A few sentences describing the overall goals of this pull request.
 
 ## Types of Changes
 
@@ -17,22 +16,25 @@ _What types of changes does your code introduce? Keep the ones that apply:_
 - Refactor/improvements
 - Documentation / non-code
 
-## Tasks
+## TODO
 
 _List of tasks you will do to complete the PR:_
 
-- [ ] Created Task 1
-- [ ] Created Task 2
-- [ ] To-do Task 3
+- [ ] TODO 1
 
 ## Review
 
-_List of tasks the reviewer must do to review the PR:_
+_Reviewers' checklist:_
 
-- [ ] Tests
-- [ ] Documentation
-- [ ] CHANGELOG
+- If this PR _implements_ new flows or _changes_ existing ones, are there
+  **good tests** for these flows?
+  If this PR rather _removes_ flows, are the obsolete tests removed as well?
+- Is the documentation still up-to-date and exhaustive? This covers both
+  _technical_ (in source files) and _functional_ (under `docs/`) documentation.
+- Is the **changelog** updated?
+- Does the **new version number** correspond to the actual changes from this PR?
+  In doubt, refer to https://semver.org.
 
-## Deployment Notes
+## After this PR
 
-These should highlight any db migrations, feature toggles, etc.
+Any follow-up action necessary?

.travis.yml

@@ -18,17 +18,12 @@ deploy:
     script: poetry publish --build
     on:
       branch: master
-      tags: true
-    skip_existing: true
-  # Development releases: every merge into master
-  - provider: script
-    script: poetry run python make_dev_release.py
-    on:
-      branch: master
-      # Dev releases are timestamp-tagged; avoid publishing one for each python
-      # version we test with.
+      # We don't want to publish a release twice (once for each supported
+      # python version), but we also cannot use skip_existing because
+      # deployment should fail if not at least one release is published to PyPI
+      # successfully. This prevents the case where someone forgot to update the
+      # version number in a PR.
       python: '3.7'
-
 env:
   global:
   - secure: duPuFLBO/bAeEnBHEQ7EHX07rLa7RO69PKH3+vTBmFVIqpZEh+X5psXTHClpFAT39AsUVvwKl5ZPwxunTOA13h6/b34M9WvArNOmMgrFvtsy2uqS9l/EJKMhhRpdL0h9Hk08Po1gJ7hEbOmFtadWtYXhge0z6bC4ykDCdKyO02sMNVceu0c+Q4j8mlV55iUjR0k9XYTRXHPyCZvhQRlWRu2SpFu+bS+i46ckdTtcLlHi0jDCAIc3od+j0ZT1CMSRdg0Bg81C9U7zCcPSpFk4AMdUjXw1h8k+7iFzzknyMDyVRi9pocPk8WXEN8i0OTGIsYCPWhgqcNP1o37xCXQj/7qPjvVYbF32vS9Ab+0RGySjlwBS19c5DoU/46IK6YR9Gpy8jmbTGbKdsK2grmg5AHs+Xv5/a5zbFoHiLRMSvqT5S8ZiAoHDKuBAQKXnHJEVYxmr1GqeOz6xPyEQlzrlbkKQlkO+D4oo3EALkq43dPo/fyKwgGVrOCyoEAfpRh/R448mVZKkuOb+IKnQCsRILpPeD8ZxQfQriVHeS4pMvZHmWA4hogZdGWe1a8xwDD2/RVclmaofyoT2HPPFgkY0wBDNlPC/RYvyXTSmAQ8XEk0CfzYh8IPsLys6v1E8MZqWG7s2xrbXQCz5jPGmmZ7MTuA20vUXGvyJCoPC6AJ/+xE=

Makefile.local

@@ -11,3 +11,11 @@ black: configure
 .PHONY: doc
 doc:
 	poetry run $(MAKE) -C docs html
+
+.PHONY: prepare-patch prepare-minor prepare-major
+prepare-patch:
+	poetry run python update-version.py patch
+prepare-minor:
+	poetry run python update-version.py minor
+prepare-major:
+	poetry run python update-version.py major

common.mk

@@ -15,6 +15,7 @@ configure: .make/configure
 .PHONY: unittest
 unittest: configure
 	poetry run pytest --failed-first --cov-config .coveragerc --cov-report xml --cov=. transformer/
+	poetry run pytest --failed-first update-version.py
 
 .PHONY: functest
 functest: configure

docs/Changelog.rst

@@ -15,14 +15,16 @@ The format is based on `Keep a Changelog`_, and this project adheres to
    :local:
    :depth: 1
 
-.. _unreleased:
+.. _v1.1.0:
 
-Unreleased
-==========
+v1.1.0
+======
+
+- Release date: 2019-03-06 17:06
 
 - Diff__.
 
-__ https://github.com/zalando-incubator/transformer/compare/v1.0.2...HEAD
+__ https://github.com/zalando-incubator/transformer/compare/v1.0.2...v1.1.0
 
 Added
 -----
@@ -68,6 +70,11 @@ Changed
 - The documentation is no longer accessible from the GitHub wiki, but is now
   hosted by Read The Docs at https://transformer.readthedocs.io. (:pr:`43`)
 
+- The release process has changed: A new PyPI release is now published for each
+  commit to the `master` branch.
+  This should prevent situations where the documentation advertises features
+  not yet released. (:pr:`46`)
+
 .. _Sphinx: http://www.sphinx-doc.org
 .. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext
 

docs/Contributing.rst

@@ -164,16 +164,30 @@ Suggested workflow
 .. _project maintainers: https://github.com/zalando-incubator/Transformer/blob/master/MAINTAINERS
 .. _mention: https://github.blog/2011-03-23-mention-somebody-they-re-notified/
 
-9. When you are done, mark your draft pull request as `Ready for review`_.
-   This will automatically request a **code review** from all `project
-   maintainers`_.
-
-   Make sure your contribution respects :ref:`Transformer's conventions
-   <project-conventions>` before that!
+9. As explained in the :ref:`release-process` section, in Transformer, **each
+   pull request merged** in the ``master`` branch becomes a **new release** on
+   PyPI.
+   Therefore, a few files need to be updated with a **new version number**, and
+   :file:`docs/Changelog.rst` should probably contain a description of your
+   contributions.
+   **Everything is explained** in :ref:`release-process`, including the
+   ``make prepare`` command that should do most of the work for you.
+
+10. You are welcome to add your name in our :ref:`contributors` file
+    (:file:`docs/Contributors.rst`).
+    This is of course optional, but we would be happy to remember and showcase
+    the help you provided!
+
+11. When you are done, mark your draft pull request as `Ready for review`_.
+    This will automatically request a **code review** from all `project
+    maintainers`_.
+
+    Make sure your contributions respect :ref:`Transformer's conventions
+    <project-conventions>` before that!
 
 .. _ready for review: https://help.github.com/en/articles/changing-the-stage-of-a-pull-request
 
-10. Your pull request must be approved 👍 by two `project maintainers`_ before
+12. Your pull request must be approved 👍 by two `project maintainers`_ before
     it can be merged.
 
 **Thank you** for your contributions!

docs/Contributors.rst

@@ -1,3 +1,5 @@
+.. _contributors:
+
 ✌ Project Contributors
 =======================