Skip to content

Commit

Permalink
add RELEASE.md and add build package to pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
tykling committed Jan 25, 2024
1 parent 45e8579 commit 376d7dc
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## unreleased

## Added
- RELEASE.md file describing how to do a release
- `build` module to the `dev` extras in `pyproject.toml`


## [v0.3.0] - 2024-01-25

### Changed
Expand Down
26 changes: 26 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Creating a release
====================

1. Update release date and version in changelog.md and commit.

2. Merge develop into main:
git checkout develop
git merge main
git checkout main
git merge --no-ff develop

3. Then tag the new release:
git tag v0.4.0 -a
<enter something like "Release v0.4.0">
git push origin v0.4.0

4. Upload new release to pypi:
rm dist/*
python -m build
twine upload dist/dns_exporter*

5. Back to development:
git checkout develop
git merge main

6. Then update CHANGELOG.md, commit and push.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ requires-python = ">=3.9"
dns_exporter = "dns_exporter.entrypoint:main"

[project.optional-dependencies]
dev = ["twine == 4.0.2", "pre-commit == 3.3.3", "setuptools-scm == 7.1.0"]
dev = ["twine == 4.0.2", "pre-commit == 3.3.3", "setuptools-scm == 7.1.0", "build==1.0.3"]
test = ["pytest == 7.4.4", "pytest-cov==4.0.0", "tox == 4.12.1", "requests==2.28.2"]
docs = ["Sphinx==7.0.1", "furo==2023.3.27"]

Expand Down

0 comments on commit 376d7dc

Please sign in to comment.