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

Migrate from Makefile to justfile #29

Merged
merged 3 commits into from
Jun 8, 2024
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
37 changes: 0 additions & 37 deletions Makefile

This file was deleted.

19 changes: 19 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,25 @@ File backend
The file backend is the only one which needs a path. The url path is store
in ``EMAIL_FILE_PATH`` key.


Running the tests
=================

Fork, then clone the repo:

.. code:: bash

git clone git@github.com:put-your-user-here/dj-email-url.git

Then you can run the tests with the *just* command runner:

.. code:: bash

just test

If you don't have *just* installed,
you can look in the ``justfile`` for the commands that are run.

License
=======

Expand Down
39 changes: 39 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# SPDX-FileCopyrightText: 2013-2022 Miguel Gonzalez <migonzalvar@gmail.com>
#
# SPDX-License-Identifier: CC0-1.0

python := ".venv/bin/python"

default: test

install:
test -e {{python}} || python -m venv .venv
{{python}} -m pip install --upgrade pip setuptools wheel
{{python}} -m pip install docutils pygments

requirements-build: install
{{python}} -m pip install build twine check-wheel-contents

release: clean test build
@echo Check:
@echo ''
@echo '[ ] Change log updated.'
@echo '[ ] Version bumped (bumpversion patch).'
@echo '[ ] Updated GitHub (git push).'
@echo ''
@echo 'Finally:'
@echo ''
@echo '[ ] Upload to PyPI (twine upload dist/*).'

test: install
{{python}} test_dj_email_url.py
{{python}} -m docutils README.rst --halt=info >/dev/null
{{python}} -m docutils CHANGELOG.rst --halt=info >/dev/null

build: requirements-build
{{python}} -m build --sdist --wheel .
{{python}} -m check_wheel_contents dist/*.whl

clean:
rm -f README.rst.html
rm -f dist/*
Loading