Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(git): Notes to alert of a git version bug #112 #113

Merged
merged 1 commit into from
Sep 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ Features
Conventional-Commits_ style git commit message template, cookiecutter
will simultaneously add it to your local git config file.

.. note::

Initialise your local git requires Git v2.33.0 or above. A bug report has
been raised and a fix is coming.

.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _cookiecutter-pypackage: https://github.com/audreyfeldroy/cookiecutter-pypackage
.. _Projects: https://github.com/imAsparky/cookiecutter-py3-package/projects
Expand Down
28 changes: 28 additions & 0 deletions docs/source/prompts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,34 @@ project.
Selecting this option also includes automatically adding the conventional
commits message template to git config if you have chosen that option.

**Initialise your local git requires Git v2.33.0 or above. A bug report has
been raised and a fix is coming.**


**use_release_to_test_pypi_with_tags**
*default = n*

Selecting this option will configure a workflow to simulate a production
test and then release to PyPi; however, the release will go to the Test
PyPi index.
This feature is helpful to help iron out any bugs before releasing your
package into the PyPi index.
To use this feature, tag with 'dev*' before pushing to the repository.
The `dev` tag will trigger the workflow.

See the example tags below

.. code-block:: bash

git tag dev
git tag dev-new-feature
git tag dev-testing-some-update

.. note::

Perhaps using semantic version below version 1.0.0 could
be one way to use the test PyPi releases.


**open_source_license**
*default = MIT*
Expand Down