🔖 bump version 0.1.0dev0 -> 0.1.0 (#15)

Author: joshuadavidthomas

CHANGELOG.md

@@ -16,6 +16,31 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 ### Security
 -->
 
+## [0.1.0]
+
+Initial release! 🎉
+
+### Added
+
+- A group of navigation classes -- `Nav`, `NavGroup`, and `NavItem` -- that can be used together to build a simple navigation structure.
+    - `Nav` is the main container for a navigation structure.
+    - `NavGroup` is a container for a group of `NavItem` objects.
+    - `NavItem` is a single navigation item.
+- A `django_simple_nav` template tag that renders a `Nav` object to a template. The template tag takes a string represented the dotted path to a `Nav` object and renders it to the template.
+- Navigation item urls can be either a URL string (e.g. `https://example.com/about/` or `/about/`) or a Django URL name (e.g. `about-view`). When rendering out to the template, the template tag will resolve the URL name to the actual URL.
+- Navigation items also can take a list of permissions to control the visibility of the item. The permissions can be user attributes (e.g. `is_staff`, `is_superuser`, etc.) or a specific permission (e.g. `auth.add_user`).
+- Navigation items are marked as `active` if the current request path matches the item's URL. This is can be useful for highlighting the current page in the navigation.
+- A `Nav` object's template can either be set as a class attribute (`template_name`) or passed in as a keyword argument when rendering the template tag. This allows for easy customization of the navigation structure on a per-template or per-view basis.
+- Initial documentation.
+- Initial tests.
+- Initial CI/CD (GitHub Actions).
+
+### New Contributors!
+
+- Josh Thomas <[email protected]> (maintainer)
+- Jeff Triplett [@jefftriplett](https://github.com/jefftriplett)
+
 ## [Unreleased]
 
-[unreleased]: https://github.com/westerveltco/django-simple-nav/compare/HEAD...HEAD
+[unreleased]: https://github.com/westerveltco/django-simple-nav/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/westerveltco/django-simple-nav/releases/tag/v0.1.0

pyproject.toml

@@ -71,7 +71,7 @@ Source = "https://github.com/westerveltco/django-simple-nav"
 [tool.bumpver]
 commit = true
 commit_message = ":bookmark: bump version {old_version} -> {new_version}"
-current_version = "0.1.0dev0"
+current_version = "0.1.0"
 push = false  # set to false for CI
 tag = false
 version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]"

src/django_simple_nav/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.1.0dev0"
+__version__ = "0.1.0"

tests/test_version.py

@@ -4,4 +4,4 @@
 
 
 def test_version():
-    assert __version__ == "0.1.0dev0"
+    assert __version__ == "0.1.0"