Skip to content

Commit

Permalink
Mention setting the default branch in git.
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianWilhelm committed Jan 19, 2022
1 parent 5ac1acb commit e37cc7c
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 4 deletions.
9 changes: 7 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Changelog
Current versions
================

Version 4.1.4, 2022-01-13
Version 4.1.5, 2022-XX-XX
-------------------------

- Ensure build configuration produces ``sdist`` as it is needed by conda, :issue:`570`
- Added ``.python-version`` created by ``pyenv`` to ``.gitignore``


Version 3.3, 2020-12-24
Expand All @@ -44,6 +44,11 @@ Version 3.3, 2020-12-24
Older versions
==============

Version 4.1.4, 2022-01-13
-------------------------

- Ensure build configuration produces ``sdist`` as it is needed by conda, :issue:`570`

Version 4.1.3, 2022-01-11
-------------------------

Expand Down
11 changes: 11 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,17 @@ Why my file is not being included in the sdist/wheel distribution?
being set to ``True``.
If you want to include *transient* files in your distributions, please check `setuptools docs on data files`_.

.. _git-default-branch:

How can I change Git's default branch when creating a new project setup with PyScaffold?

The default branch in Git used to be ``master`` (and still is at least until version 2.32) but nowadays ``main`` is a
preferred name. When you use PyScaffold's ``putup`` to set up your project and want to explicitly set the default branch
name, just configure this using ``git config``, e.g.::

$ git config --global init.defaultBranch main

In case you already created the project scaffold, you can just rename the branch, e.g. with ``git branch -m master main``.

File Organisation and Directory Structure
-----------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ you can also do::
twine upload --repository testpypi dist/*

Please notice that PyPI_ does not allow uploading local versions, e.g. ``0.0.dev5+gc5da6ad``,
for practical reasons. Thus, you have to create a git tag before uploading a version
for practical reasons. Thus, you have to create a Git tag before uploading a version
of your distribution. Read more about it in the versioning_ section below.

.. warning::
Expand Down
3 changes: 2 additions & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Requirements

The installation of PyScaffold only requires a recent version of of `setuptools`_,
(at least version 46.1), pip_, as well as a `working installation of Git`_
(meaning at least your *name and email were configured* in your first-time `git setup`_).
(meaning at least your *name and email were configured* but also
:ref:`setting the default branch <git-default-branch>` might be useful in your first-time `git setup`_).
Especially Windows users should make sure that the command ``git`` is available on
the command line. Otherwise, check and update your ``PATH`` environment
variable or run PyScaffold from the *Git Bash*.
Expand Down

0 comments on commit e37cc7c

Please sign in to comment.