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

better description of development process #70

Merged
merged 1 commit into from
Dec 7, 2023
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,20 @@ the commit hooks.

.. code-block:: bash

$ pip install -r requirements-dev.txt
$ pre-commit install
poetry install --with=dev,test
pre-commit install

Feature branches are merged into the `develop` branch. This branch is merged into the `main` branch whenever a new stable release is published.
Feature branches are merged into the `develop` branch.

Publishing
----------

To publish a new release from ``develop``, create a new branch, increment the version number and push to github. For convenience, there is a ``create_release_branch.sh`` script that accomplishes the same, which takes one argument:

.. code-block:: bash

create_release_branch.sh major # or minor, or patch, or specific version number

Then, from the github website, the release can be published by clicking the "tags" button. Be sure to select the correct branch.

When done, merge the release branch into ``develop`` and ``main``, and delete it.
22 changes: 22 additions & 0 deletions create_release_branch.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/usr/bin/env bash

set -e

if [ $# -eq 0 ]; then
echo "please write the type of release you would like to perform (major, minor, patch, or a specific version)"
exit 1
fi

git fetch origin
git checkout develop
git pull origin develop

poetry version $1
version=$(poetry version --short)
message="Portfolyo Release $version"

git checkout -b $version

git add pyproject.toml
git commit -m "$message"
git push origin $version
Loading