Doctr

Latest version: v1.8.0

Safety actively analyzes 613568 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 4

1.8.0

==================

Major Changes
-------------

- Doctr now supports repos hosted on travis-ci.com (in addition to .org).
(:issue:`310`)

Some notes about travis-ci.com support:

* travis-ci.org and travis-ci.com have different public keys for the same
repo, so it is necessary for ``doctr configure`` to know which is being
used. If you want to move from travis-ci.org to travis-ci.com, you will
need to reconfigure.

* If only one of travis-ci.org or travis-ci.com is enabled, ``doctr
configure`` will automatically configure the repo for that one. If both
are enabled, it will ask which one to configure for. You can also use the
``--travis-tld`` command line flag to ``doctr configure`` to specify which
one to use.

* Once configured, there is no difference in the ``.travis.yml`` file.

* If for whatever reason you want to run doctr on both, you can configure
each separately, renaming the encrypted files that they generate. Add both
secure environment variables to ``.travis.yml``, and do something like

.. code:: bash

if [[ $TRAVIS_BUILD_WEB_URL == *"travis-ci.com"* ]]; then
doctr deploy --built-docs <built-docs> . --key-path github_deploy_key-com.enc;
else
doctr deploy --built-docs <built-docs> . --key-path github_deploy_key-org.enc;
fi


- New ``-no-authenticate`` flag to ``doctr configure``. This disables
authentication with GitHub. If GitHub authentication is required (i.e., the
repository is private), then it will fail. This
flag implies ``-no-upload-key``, which now no longer disables
authentication. (:issue:`310`)

- Doctr does not attempt to push on Travis builds of forks. Note, this
requires using the GitHub API to check if the repo is a fork, which often
fails. If it does, the build will error anyway (which can be ignored). You
can use `Travis conditions <https://docs.travis-ci.com/user/conditions-v1>`_
if you need a build to not fail on a fork. (:issue:`332`)

- Doctr is now better tested on private repositories. Private repositories now
work with both ``--token`` and a deploy key (a deploy key the default and is
recommended). Note that configuring Travis for a private repository will
generate a temporary personal access token on GitHub, and immediately delete
it. This is necessary to authenticate with Travis. You will receive an email
from GitHub about it. (:issue:`337`)


Minor Changes
-------------

- Fix the ``--branch-whitelist`` flag with no arguments. (:issue:`330`,
:issue:`334`)

- Print the doctr version at the beginning of deploy. (:issue:`333`)

- Fix ``doctr deploy --built-docs file`` when the deploy directory doesn't
exist. (:issue:`332)`

- Improved error message when doctr is not configured properly. (:issue:`338`)

1.7.4

==================

Major Changes
-------------

- Run a single ``git add`` and ``git rm`` command for all the files. This
drastically improves the performance of doctr when there are many files that
are synced. (:issue:`325`)

- Improve the error messaging in ``doctr configure`` when the 2FA code
expires, and when the GitHub API rate limit is hit. The GitHub API rate
limit is shared across all OAuth applications, and is often hit after
clicking the "sync account" button on travis-ci.org, especially if you have
access to a large number of repos. If this happens, you must wait an hour
and run ``doctr configure`` again. (:issue:`320`)

Minor Changes
-------------

- Improve error messages when the deploy key isn't found. (:issue:`306`)

- Doctr doesn't commit when the most recent commit on the main repo was by
doctr. This avoids infinite loops if you accidentally run doctr from the
``master`` branch of a ``.github.io`` instead of a separate branch. See
the :ref:`recipe-github-io` recipe. (:issue:`318`)

1.7.3

==================

Minor Changes
-------------

- Use the ``cryptography`` module to generate the SSH deploy key instead of
``ssh-keygen``. This makes it possible to run ``doctr configure`` on
Windows. (:issue:`303`)

1.7.2

==================

Major Changes
-------------

- Update Travis API call to Travis API v3 (``doctr configure`` now works
again). (:issue:`298`)

- Add ``--exclude`` flag to ``doctr deploy`` to chose files and directories
from ``--built-docs`` that should be excluded from being deployed.
(:issue:`296`)

Minor Changes
-------------

- Fix ``--built-docs .``. (:issue:`294`)

1.7.1

==================

Major Changes
-------------

.. role:: red

.. role:: green

.. role:: blue

.. role:: magenta

.. role:: gray

.. raw:: html

<style> .red {color:red} .green {color:green} .blue {color:blue}
.magenta {color:magenta; font-weight:bold} .gray {color:dimgray; font-weight:bold} </style>

- Cleanup the ``doctr configure`` code. Output is now
color-coded according to its meaning:

- :red:`red`: warnings and errors
- :green:`green`: welcome messages (used sparingly)
- :blue:`blue`: default values
- :magenta:`bold magenta`: action items
- :gray:`bold gray`: things that should be replaced when copy-pasting

The ``doctr configure`` text has also been improved. (:issue:`289`)

Minor Changes
-------------

- Retry on invalid username and password in ``doctr configure``. (:issue:`289`)

- Print when the 2FA code fails in ``doctr configure``. (:issue:`289`)

- Fix the ``--branch-whitelist`` flag to ``doctr deploy``. (:issue:`291`)

1.7.0

==================

Major Changes
-------------

- Add support for multiple deploy repos. Thanks :user:`ylemkimon`. Note, as a
result of this, the default environment variable name on Travis is now
:samp:`DOCTR_DEPLOY_ENCRYPTION_KEY_{ORG}_{REPO}` where :samp:`{ORG}` and
:samp:`{REPO}` are the GitHub organization and repo, capitalized with
special characters replaced with underscores. The default encryption key
file is now :samp:`doctr_deploy_key_{org}_{repo}.enc`, where :samp:`{org}`
and :samp:`{repo}` are the organization and repo names with special
characters replaced with underscores. The old key and file names are still
supported for backwards compatibility, and a custom key file name can still
be used with the ``--key-path`` flag. (:issue:`276` and :issue:`280`)

- Add support for deploying to GitHub wikis. Thanks :user:`ylemkimon`. The
wiki for a GitHub repository is :samp:`{org}/{repo}.wiki`. The deploy key
for a wiki is the same as for the repository itself, so if you have already
run ``doctr configure`` for a given repository you do not need to run it
again for its wiki. See :ref:`the recipes page <recipe-wikis>` for more
information. (:issue:`276` and :issue:`280`)


- Add support for deploying from tag builds. Tag builds are builds
that Travis CI runs on tags pushed up to the repository. See
:ref:`the recipes page <recipe-tags>` for more information. (:issue:`225`)

Minor Changes
-------------

- Add a global table of contents to the docs sidebar. (:issue:`284`)
- Note in the docs that doctr will make the ``gh-pages`` branch for you if it
doesn't exist. Thanks :user:`CJ-Wright`. (:issue:`235`)
- Print a more helpful error message when the repository check in ``doctr
configure`` fails. Thanks :user:`ylemkimon`. (:issue:`279`)

Page 1 of 4

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.