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.

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

Migrate to bump-my-version #59

Merged
merged 2 commits into from
Nov 9, 2023
Merged

Migrate to bump-my-version #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1b750
Migrate to bump-my-version
protoroto Nov 9, 2023
96b9f2f
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 9, 2023
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
165 changes: 1 addition & 164 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,167 +5,4 @@ Contributing
Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
**********************

Report Bugs
===========

Report bugs at https://github.com/nephila/django-app-enabler/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
========

Look through the GitHub issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.

Implement Features
==================

Look through the GitHub issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.

Write Documentation
===================

django-app-enabler could always use more documentation, whether as part of the
official django-app-enabler docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
===============

The best way to send feedback is to file an issue at https://github.com/nephila/django-app-enabler/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)

************
Get Started!
************

Ready to contribute? Here's how to set up ``django-app-enabler`` for local development.

1. Fork the ``django-app-enabler`` repo on GitHub.
2. Clone your fork locally::

$ git clone [email protected]:your_name_here/django-app-enabler.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper
installed, this is how you set up your fork for local development::

$ mkvirtualenv django-app-enabler
$ cd django-app-enabler/
$ pip install -r requirements-test.txt
$ pip install -e .

4. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::

$ tox

To get tox, pip install it into your virtualenv.

6. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.

Development tips
----------------

This project allows you to use `pre-commit <https://pre-commit.com/>`_ to ensure an easy compliance
to the project code styles.

If you want to use it, install it globally (for example with ``pip3 install --user precommit``,
but check `installation instruction <https://pre-commit.com/#install>`.
When first cloning the project ensure you install the git hooks by running ``pre-commit install``.

From now on every commit will be checked against our code style.

Check also the available tox environments with ``tox -l``: the ones not marked with a python version number are tools
to help you work on the project buy checking / formatting code style, running docs etc.

Testing tips
----------------
You can test your project using any specific combination of python, django and django cms.

For example ``tox -py37-django30-cms37`` runs the tests on python 3.7, Django 3.0 and django CMS 3.7.

As the project uses `pytest <https://pytest.org/>`_ as test runner, you can pass any pytest option by setting the
``PYTEST_ARGS`` environment variable, usually by prepending to the ``tox`` command. Example::

PYTEST_ARGS=" -s tests/test_plugins.py::PluginTest -p no:warnings" tox -py37-django30-cms37


Pull Request Guidelines
=======================

Before you submit a pull request, check that it meets these guidelines:

#. Pull request must be named with the following naming scheme:

``<type>/(<optional-task-type>-)<number>-description``

See below for available types.

#. The pull request should include tests.
#. If the pull request adds functionality, the docs should be updated.
Documentation must be added in ``docs`` directory, and must include usage
information for the end user.
In case of public API method, add extended docstrings with full parameters
description and usage example.
#. Add a changes file in ``changes`` directory describing the contribution in
one line. It will be added automatically to the history file upon release.
File must be named as ``<issue-number>.<type>`` with type being:

* ``.feature``: For new features.
* ``.bugfix``: For bug fixes.
* ``.doc``: For documentation improvement.
* ``.removal``: For deprecation or removal of public API.
* ``.misc``: For general issues.

Check `towncrier`_ documentation for more details.

#. The pull request should work for all python / django / django CMS versions
declared in tox.ini.
Check the CI and make sure that the tests pass for all supported versions.

Release a version
=================

#. Update authors file
#. Merge ``develop`` on ``master`` branch
#. Bump release via task: ``inv tag-release (major|minor|patch)``
#. Update changelog via towncrier: ``towncrier --yes``
#. Commit changelog with ``git commit --amend`` to merge with bumpversion commit
#. Create tag ``git tag <version>``
#. Push tag to github
#. Publish the release from the tags page
#. If pipeline succeeds, push ``master``
#. Merge ``master`` back on ``develop``
#. Bump developement version via task: ``inv tag-dev -l (major|minor|patch)``
#. Push ``develop``

.. _towncrier: https://pypi.org/project/towncrier/#news-fragments
Please read the instructions `here <https://nephila.github.io/contributing/contributing>`_ to start contributing to `django-app-enabler`.
1 change: 1 addition & 0 deletions changes/58.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Migrate to bump-my-version
32 changes: 32 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,35 @@ target-version = "py310"

[tool.ruff.mccabe]
max-complexity = 10

[tool.bumpversion]
allow_dirty = false
commit = true
message = "Release {new_version}"
commit_args = "--no-verify"
tag = false
current_version = "0.2.0"
parse = """(?x)
(?P<major>[0-9]+)
\\.(?P<minor>[0-9]+)
\\.(?P<patch>[0-9]+)
(?:
.(?P<release>dev)
(?:(?P<relver>[0-9]+))?
)?
"""
serialize = [
"{major}.{minor}.{patch}.{release}{relver}",
"{major}.{minor}.{patch}"
]

[tool.bumpversion.parts.release]
values = [
"dev",
""
]
optional_value = "dev"

[[tool.bumpversion.files]]
filename = "app_enabler/__init__.py"
search = "{current_version}"
17 changes: 11 additions & 6 deletions tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ def format(c): # NOQA
def towncrier_check(c): # NOQA
"""Check towncrier files."""
output = io.StringIO()
c.run("git branch --contains HEAD", out_stream=output)
skipped_branch_prefix = ["pull/", "develop", "master", "HEAD"]
c.run("git branch -a --contains HEAD", out_stream=output)
skipped_branch_prefix = ["pull/", "release/", "develop", "master", "HEAD"]
# cleanup branch names by removing PR-only names in local, remote and disconnected branches to ensure the current
# (i.e. user defined) branch name is used
branches = list(
Expand Down Expand Up @@ -109,15 +109,20 @@ def coverage(c):


@task
def tag_release(c, level):
def tag_release(c, level, new_version=""):
"""Tag release version."""
c.run("bumpversion --list %s --no-tag" % level)
c.run(f"bump-my-version bump {level}{new_version}")


@task
def tag_dev(c, level="patch"):
def tag_dev(c, level, new_version=""):
"""Tag development version."""
c.run("bumpversion --list %s --message='Bump develop version [ci skip]' --no-tag" % level)
if new_version:
new_version = f" --new-version {new_version}"
elif level == "release":
c.run("bump-my-version bump patch --no-commit")
level = "relver"
c.run(f"bump-my-version bump {level} --message='Bump develop version [ci skip]' {new_version} --allow-dirty")


@task(pre=[clean])
Expand Down
Loading