travis2docker 6.4.24__tar.gz → 6.4.25__tar.gz

{travis2docker-6.4.24 → travis2docker-6.4.25}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 6.4.24
+current_version = 6.4.25
 commit = True
 tag = True
 

{travis2docker-6.4.24 → travis2docker-6.4.25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: travis2docker
-Version: 6.4.24
+Version: 6.4.25
 Summary: Script to generate Dockerfile from .travis.yml file
 Home-page: https://github.com/vauxoo/travis2docker
 Author: Vauxoo
@@ -151,6 +151,86 @@ Note, to combine the coverage data from all the tox environments run:
             PYTEST_ADDOPTS=--cov-append tox
 
 
+Release process
+===============
+
+This project uses `bump2version <https://github.com/c4urself/bump2version>`_ to
+manage version bumps across ``.bumpversion.cfg``, ``docs/conf.py``,
+``setup.py`` and ``src/travis2docker/__init__.py``.
+
+Requirements
+************
+
+* Write access to push to ``main`` and to push tags.
+* A GPG key configured for signing git tags. The CI pipeline that publishes
+  the package to PyPI only builds from **signed** tags::
+
+      git config --global user.signingkey <YOUR_GPG_KEY_ID>
+
+* ``bump2version`` installed::
+
+      pip install bump2version
+
+Steps to release a new version
+******************************
+
+
+1. Make sure you are on ``main`` and it is up to date, with no local commits
+   ahead of ``origin``::
+
+       git checkout main
+       git pull origin main
+       git status  # must be clean
+
+2. Bump the version. This creates a commit and a tag automatically
+   (choose ``patch``, ``minor`` or ``major`` as needed)::
+
+       bump2version patch
+
+   This updates::
+
+       .bumpversion.cfg
+       docs/conf.py
+       setup.py
+       src/travis2docker/__init__.py
+
+3. Verify the tag was created and that it is **signed**::
+
+       git tag -v vX.Y.Z
+
+   If ``sign_tags`` is not enabled in ``.bumpversion.cfg``, the tag created
+   in step 2 will **not** be signed and the CI build/publish step will not
+   run. In that case, re-create the tag manually before pushing::
+
+       git tag -d vX.Y.Z
+       git tag -s vX.Y.Z -m "vX.Y.Z"
+
+   To avoid this every time, add the following to ``.bumpversion.cfg``::
+
+       [bumpversion]
+       current_version = X.Y.Z
+       commit = True
+       tag = True
+       sign_tags = True
+
+4. Push the branch and the tag::
+
+       git push origin main --tags
+
+   Pushing the signed tag is what triggers the CI job that builds and
+   publishes the package to PyPI.
+
+Troubleshooting
+***************
+
+* **"tag already exists" / dirty working tree**: make sure ``git status`` is
+  clean and ``git pull origin main`` was run before ``bump2version``,
+  otherwise the bump commit/tag will be based on stale history.
+* **CI does not trigger a PyPI build**: check that the pushed tag is signed
+  (``git tag -v vX.Y.Z`` should show a valid GPG signature) and that
+  ``user.signingkey`` is configured correctly.
+
+
 Changelog
 =========
 

{travis2docker-6.4.24 → travis2docker-6.4.25}/README.rst

@@ -156,3 +156,83 @@ Note, to combine the coverage data from all the tox environments run:
       - ::
 
             PYTEST_ADDOPTS=--cov-append tox
+
+
+Release process
+===============
+
+This project uses `bump2version <https://github.com/c4urself/bump2version>`_ to
+manage version bumps across ``.bumpversion.cfg``, ``docs/conf.py``,
+``setup.py`` and ``src/travis2docker/__init__.py``.
+
+Requirements
+************
+
+* Write access to push to ``main`` and to push tags.
+* A GPG key configured for signing git tags. The CI pipeline that publishes
+  the package to PyPI only builds from **signed** tags::
+
+      git config --global user.signingkey <YOUR_GPG_KEY_ID>
+
+* ``bump2version`` installed::
+
+      pip install bump2version
+
+Steps to release a new version
+******************************
+
+
+1. Make sure you are on ``main`` and it is up to date, with no local commits
+   ahead of ``origin``::
+
+       git checkout main
+       git pull origin main
+       git status  # must be clean
+
+2. Bump the version. This creates a commit and a tag automatically
+   (choose ``patch``, ``minor`` or ``major`` as needed)::
+
+       bump2version patch
+
+   This updates::
+
+       .bumpversion.cfg
+       docs/conf.py
+       setup.py
+       src/travis2docker/__init__.py
+
+3. Verify the tag was created and that it is **signed**::
+
+       git tag -v vX.Y.Z
+
+   If ``sign_tags`` is not enabled in ``.bumpversion.cfg``, the tag created
+   in step 2 will **not** be signed and the CI build/publish step will not
+   run. In that case, re-create the tag manually before pushing::
+
+       git tag -d vX.Y.Z
+       git tag -s vX.Y.Z -m "vX.Y.Z"
+
+   To avoid this every time, add the following to ``.bumpversion.cfg``::
+
+       [bumpversion]
+       current_version = X.Y.Z
+       commit = True
+       tag = True
+       sign_tags = True
+
+4. Push the branch and the tag::
+
+       git push origin main --tags
+
+   Pushing the signed tag is what triggers the CI job that builds and
+   publishes the package to PyPI.
+
+Troubleshooting
+***************
+
+* **"tag already exists" / dirty working tree**: make sure ``git status`` is
+  clean and ``git pull origin main`` was run before ``bump2version``,
+  otherwise the bump commit/tag will be based on stale history.
+* **CI does not trigger a PyPI build**: check that the pushed tag is signed
+  (``git tag -v vX.Y.Z`` should show a valid GPG signature) and that
+  ``user.signingkey`` is configured correctly.

{travis2docker-6.4.24 → travis2docker-6.4.25}/docs/conf.py

@@ -26,7 +26,7 @@ project = u'travis2docker'
 year = '2016'
 author = u'Vauxoo'
 copyright = '{0}, {1}'.format(year, author)
-version = release = u'6.4.24'
+version = release = u'6.4.25'
 
 pygments_style = 'trac'
 templates_path = ['.']

{travis2docker-6.4.24 → travis2docker-6.4.25}/setup.py

@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name="travis2docker",
-    version="6.4.24",
+    version="6.4.25",
     license="BSD-3-Clause",
     description="Script to generate Dockerfile from .travis.yml file",
     long_description="%s\n%s"

travis2docker-6.4.25/src/travis2docker/__init__.py

@@ -0,0 +1 @@
+__version__ = "6.4.25"

{travis2docker-6.4.24 → travis2docker-6.4.25}/src/travis2docker/templates/build.sh

@@ -99,7 +99,6 @@ install_dev_tools(){
         virtualenv \
         ipdb \
         pre-commit-vauxoo \
-        diff-highlight \
         pg-activity \
         nodeenv \
         pdbpp
@@ -116,6 +115,11 @@ install_dev_tools(){
     touch /home/odoo/full_test-requirements.txt
     sudo -E pip install -r /home/odoo/full_test-requirements.txt
 
+    # Install git-delta from .deb since not all Ubuntu versions ship the package
+    GIT_DELTA_VERSION=0.18.2
+    wget -q https://github.com/dandavison/delta/releases/download/${GIT_DELTA_VERSION}/git-delta_${GIT_DELTA_VERSION}_$(dpkg --print-architecture).deb -O /tmp/git-delta.deb && \
+        apt install -qqq -y /tmp/git-delta.deb || true
+
     # Keep alive the ssh server
     #   60 seconds * 360 = 21600 seconds = 6 hours
     # https://www.bjornjohansen.no/ssh-timeout
@@ -126,13 +130,16 @@ install_dev_tools(){
     wget -O /tmp/ngrok.tgz https://bin.equinox.io/c/bNyj1mQVY4c/ngrok-v3-stable-linux-amd64.tgz && \
     tar xvzf /tmp/ngrok.tgz -C /usr/local/bin || true
 
-    # Configure diff-highlight on git after install
-    cat >> /etc/gitconfig << EOF
-[pager]
-    log = diff-highlight | less
-    show = diff-highlight | less
-    diff = diff-highlight | less
-EOF
+    # Configure color for git diff if git-delta is already installed
+    if command -v delta >/dev/null 2>&1; then
+        git config --system core.pager delta
+        git config --system interactive.diffFilter "delta --color-only"
+
+        git config --system delta.navigate true
+        git config --system delta.line-numbers true
+        git config --system delta.syntax-theme DarkNeon
+        git config --system delta.keep-plus-minus-markers true
+    fi
     cat >> /etc/multitail.conf << EOF
 # Odoo log
 colorscheme:odoo

{travis2docker-6.4.24 → travis2docker-6.4.25}/src/travis2docker.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: travis2docker
-Version: 6.4.24
+Version: 6.4.25
 Summary: Script to generate Dockerfile from .travis.yml file
 Home-page: https://github.com/vauxoo/travis2docker
 Author: Vauxoo
@@ -151,6 +151,86 @@ Note, to combine the coverage data from all the tox environments run:
             PYTEST_ADDOPTS=--cov-append tox
 
 
+Release process
+===============
+
+This project uses `bump2version <https://github.com/c4urself/bump2version>`_ to
+manage version bumps across ``.bumpversion.cfg``, ``docs/conf.py``,
+``setup.py`` and ``src/travis2docker/__init__.py``.
+
+Requirements
+************
+
+* Write access to push to ``main`` and to push tags.
+* A GPG key configured for signing git tags. The CI pipeline that publishes
+  the package to PyPI only builds from **signed** tags::
+
+      git config --global user.signingkey <YOUR_GPG_KEY_ID>
+
+* ``bump2version`` installed::
+
+      pip install bump2version
+
+Steps to release a new version
+******************************
+
+
+1. Make sure you are on ``main`` and it is up to date, with no local commits
+   ahead of ``origin``::
+
+       git checkout main
+       git pull origin main
+       git status  # must be clean
+
+2. Bump the version. This creates a commit and a tag automatically
+   (choose ``patch``, ``minor`` or ``major`` as needed)::
+
+       bump2version patch
+
+   This updates::
+
+       .bumpversion.cfg
+       docs/conf.py
+       setup.py
+       src/travis2docker/__init__.py
+
+3. Verify the tag was created and that it is **signed**::
+
+       git tag -v vX.Y.Z
+
+   If ``sign_tags`` is not enabled in ``.bumpversion.cfg``, the tag created
+   in step 2 will **not** be signed and the CI build/publish step will not
+   run. In that case, re-create the tag manually before pushing::
+
+       git tag -d vX.Y.Z
+       git tag -s vX.Y.Z -m "vX.Y.Z"
+
+   To avoid this every time, add the following to ``.bumpversion.cfg``::
+
+       [bumpversion]
+       current_version = X.Y.Z
+       commit = True
+       tag = True
+       sign_tags = True
+
+4. Push the branch and the tag::
+
+       git push origin main --tags
+
+   Pushing the signed tag is what triggers the CI job that builds and
+   publishes the package to PyPI.
+
+Troubleshooting
+***************
+
+* **"tag already exists" / dirty working tree**: make sure ``git status`` is
+  clean and ``git pull origin main`` was run before ``bump2version``,
+  otherwise the bump commit/tag will be based on stale history.
+* **CI does not trigger a PyPI build**: check that the pushed tag is signed
+  (``git tag -v vX.Y.Z`` should show a valid GPG signature) and that
+  ``user.signingkey`` is configured correctly.
+
+
 Changelog
 =========
 

travis2docker-6.4.24/src/travis2docker/__init__.py

@@ -1 +0,0 @@
-__version__ = "6.4.24"