Skip to content

Commit

Permalink
moved git tags info into dev install (#245)
Browse files Browse the repository at this point in the history
  • Loading branch information
shimwell authored Jun 19, 2024
1 parent 629ec26 commit c433561
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
13 changes: 13 additions & 0 deletions docs/developer_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,19 @@ Checkout feature branches from dev and make local changes on you own branch
Pull requests are welcome

Keeping your fork tags up to date
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Note that your fork of the repository should have releases tags which conform to PEP440 i.e. semantic versioning.
When installing, setuptools uses these tags to get the version of GEOUNED.
Release versions in the central repository conform to this standard.
You can keep the tags in your fork up to date with the main repository using:

.. code-block:: sh
git fetch --tags https://github.com/GEOUNED-org/GEOUNED
Building the docs locally
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
10 changes: 0 additions & 10 deletions docs/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,7 @@ Currently the Mamba / Conda install is the recommended method.
The main complication when installing GEOUNED is integration between the main dependency (FreeCAD) and the users system Python.
Mamba / Conda provides a connection between the FreeCAD Python library and your system Python.
Users have also had success installing FreeCAD and making use of the Python version inbuilt into FreeCAD and the freecad.cmd however the integration of FrreCAD with the system Python is more challenging when installing in this manner.
.. TODO as well so these installation methods are listed for completeness.

Note that your fork of the repostory must have releases which conform to PEP440 i.e. semantic versioning. When installing, setuptools
uses these tags to get the release number of GEOUNED. Release versions in the central repository now conform to this standard and can be reflected in your
fork using:

.. code-block:: sh
git fetch --tags upstream
where upstream is the remote url of the original repository.

.. toctree::
:numbered:
Expand Down

0 comments on commit c433561

Please sign in to comment.