Skip to content

Update README after changing default branch from develop to master #217

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.

Sign up for GitHub

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

Merged
hf-kklein merged 5 commits into from
Dec 8, 2021
Merged

Update README after changing default branch from develop to master #217

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b7237fd
Update README.rst
hf-kklein Dec 1, 2021
d16fe92
Merge branch 'master' into hf-kklein-patch-2
hf-kklein Dec 8, 2021
7f5fc24
Update README.rst
hf-kklein Dec 8, 2021
fc27ecc
Merge branch 'master' into hf-kklein-patch-2
hf-kklein Dec 8, 2021
db08899
Merge branch 'master' into hf-kklein-patch-2
hf-kklein Dec 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Contributions are welcome.
Feel free to open a Pull Request against the develop branch of this repository.
Please provide unit tests if you contribute logic beyond bare bare business object definitions.

To enhance this BO4E implementation and contribute to this project check out the `develop branch`_, install `tox`_ and set the virtual environment created by the command
To enhance this BO4E implementation and contribute to this project check out the `master branch`_, install `tox`_ and set the virtual environment created by the command

.. code-block:: Shell

Expand Down Expand Up @@ -113,14 +113,14 @@ Release workflow
================
* Check with tox all tests and lintings: `tox`
* Check with tox if the packaging works fine: `tox -e test_packaging`
* Merge all your changes you would like to have in the release into the master branch (`open new PR develop→master`_)
* Merge all your changes you would like to have in the release into the master branch
* Check that all Github actions for tests and linting do pass (should be automatically enforced for PRs against master)
* Go to `BO4E-python`_ and click on "`Draft a new release`_" in the right sidebar
* Write in the *Tag version* field and in the *Release title* your new version, i.e. `v0.0.6`
* Add a describtion to the release
* Publish the release

There is a github action which gets triggered by a release event.
There is a Github Action which gets triggered by a release event.
It will run all default tests with tox. If they pass, it will take the tag title to replace the version information in the *setup.cfg* file.
After checking the package with `twine check` it will finally upload the new package release.

Expand All @@ -138,10 +138,9 @@ Applications of talented developers are welcome at any time! Please consider vis
.. _`Hochfrequenz Unternehmensberatung GmbH`: https://www.hochfrequenz.de
.. _`Kununu ratings`: https://www.kununu.com/de/hochfrequenz-unternehmensberatung1
.. _`career page`: https://www.hochfrequenz.de/karriere/stellenangebote/full-stack-entwickler/
.. _`develop branch`: https://github.com/Hochfrequenz/BO4E-python/tree/develop
.. _`master branch`: https://github.com/Hochfrequenz/BO4E-python/tree/master
.. _`tox`: https://pypi.org/project/tox/
.. _`BO4E-python`: https://github.com/Hochfrequenz/BO4E-python
.. _`open new PR develop→master`: https://github.com/Hochfrequenz/BO4E-python/compare/master...develop
.. _`Draft a new release`: https://github.com/Hochfrequenz/BO4E-python/releases/new
.. _`Retrieving package version at runtime`: https://pypi.org/project/setuptools-scm/
.. _`regex101`: https://regex101.com/r/JWeb51/2