fix: ensure semantic-release creates v1.0.0 with wheel uploads (#96)

- Add git reset to ensure workflow runs on exact commit SHA
- Add ref checkout and Force branch to workflow SHA step
- Add missing permissions (actions: read, issues: read)
- Make dist_glob_patterns specific for .whl and .tar.gz files
- Disable PyPI publishing (dist = false) until OIDC is configured
- Add version_toml configuration for semantic-release to handle pyproject.toml
- Update generate_pyproject.py to not overwrite semantic-release version updates
- Simplify build target to let semantic-release handle versioning
- Add custom release notes template with proper section ordering
- Delete stray :wq! file
- This ensures semantic-release works correctly and attaches build artifacts

Author: fgogolli

.github/workflows/semantic-release.yml

@@ -28,6 +28,8 @@ permissions:
   pull-requests: read
   id-token: write
   packages: write
+  actions: read
+  issues: read
 
 jobs:
   release:
@@ -41,6 +43,11 @@ jobs:
         with:
           fetch-depth: 0
           token: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ github.ref_name }}
+
+      - name: Force branch to workflow SHA
+        run: |
+          git reset --hard ${{ github.sha }}
 
       - name: Setup Python and UV
         uses: ./.github/actions/setup-python-uv

.release-notes-templates/RELEASE_NOTES.md.j2

@@ -0,0 +1,95 @@
+## {{ version.as_tag() }} ({{ version.commit_date.strftime("%Y-%m-%d") }})
+
+_This release is published under the Apache-2.0 License._
+
+{% if version.breaking_changes %}
+### Breaking Changes
+
+{% for commit in version.breaking_changes %}
+- {{ commit.descriptions[0] | capitalize }}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.feature_commits %}
+### Features
+
+{% for commit in version.feature_commits %}
+- {{ commit.descriptions[0] | capitalize }}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.fix_commits %}
+### Bug Fixes
+
+{% for commit in version.fix_commits %}
+- {{ commit.descriptions[0] | capitalize }}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.performance_commits %}
+### Performance Improvements
+
+{% for commit in version.performance_commits %}
+- {{ commit.descriptions[0] | capitalize }}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.refactor_commits %}
+### Refactoring
+
+{% for commit in version.refactor_commits %}
+- {{ commit.descriptions[0] | capitalize }}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.chore_commits %}
+### Chores
+
+{% for commit in version.chore_commits %}
+- {{ commit.descriptions[0] | capitalize }}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.documentation_commits %}
+### Documentation
+
+{% for commit in version.documentation_commits %}
+- {{ commit.descriptions[0] | capitalize }}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.style_commits %}
+### Code Style
+
+{% for commit in version.style_commits %}
+- {{ commit.descriptions[0] | capitalize }}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.test_commits %}
+### Tests
+
+{% for commit in version.test_commits %}
+- {{ commit.descriptions[0] | capitalize %}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.build_commits %}
+### Build System
+
+{% for commit in version.build_commits %}
+- {{ commit.descriptions[0] | capitalize %}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+{% if version.ci_commits %}
+### Continuous Integration
+
+{% for commit in version.ci_commits %}
+- {{ commit.descriptions[0] | capitalize %}{% if commit.scope %} ({{ commit.scope }}){% endif %} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
+{% endfor %}
+
+{% endif %}
+---
+
+**Detailed Changes**: [{{ version.previous_version.as_tag() }}...{{ version.as_tag() }}]({{ version.previous_version.as_tag() | compare_url(version.as_tag()) }})

:wq!

@@ -104,6 +104,17 @@ def update_pyproject_selective(pyproject_path: Path) -> None:
     lines = content.split("\n")
     new_lines = []
 
+    # Check if version was already updated by semantic-release
+    current_version = None
+    for line in lines:
+        if line.strip().startswith('version = "'):
+            current_version = line.strip().split('"')[1]
+            break
+
+    # If current version is different from .project.yml, don't overwrite it
+    # (semantic-release has already updated it)
+    use_current_version = current_version and current_version != version
+
     i = 0
     while i < len(lines):
         line = lines[i].strip()
@@ -115,7 +126,7 @@ def update_pyproject_selective(pyproject_path: Path) -> None:
                 [
                     "[project]",
                     f'name = "{package_name}"',
-                    f'version = "{version}"',
+                    f'version = "{current_version if use_current_version else version}"',
                     f'description = "{description}"',
                     'readme = "README.md"',
                     'license = "Apache-2.0"',

dev-tools/scripts/generate_pyproject.py

@@ -61,8 +61,7 @@ ci-docs-deploy:  ## Deploy documentation to GitHub Pages (matches docs.yml main
 # Dummy targets removed (consolidated in quality.mk)
 
 # @SECTION Build & Deploy
-build: clean dev-install  ## Build package
-	VERSION=$${VERSION:-$$(make -s get-version)} $(MAKE) generate-pyproject && \
+build: clean venv-setup  ## Build package
 	VERSION=$${VERSION:-$$(make -s get-version)} BUILD_ARGS="$(BUILD_ARGS)" ./dev-tools/package/build.sh
 
 build-test: build  ## Build and test package installation

makefiles/deploy.mk

@@ -286,6 +286,7 @@ namespace_packages = true
 
 [tool.semantic_release]
 version_variables = [".project.yml:project.version"]
+version_toml = ["pyproject.toml:project.version"]
 build_command = "make build"
 major_on_zero = true
 allow_zero_version = true
@@ -309,6 +310,7 @@ prerelease = true
 
 [tool.semantic_release.changelog.default_templates]
 changelog_file = "CHANGELOG.md"
+template_dir = ".release-notes-templates"
 
 [tool.semantic_release.commit_parser_options]
 minor_tags = ["feat"]
@@ -321,5 +323,6 @@ name = "origin"
 type = "github"
 
 [tool.semantic_release.publish]
-dist_glob_patterns = ["dist/*"]
+dist = false
+dist_glob_patterns = ["dist/*.whl", "dist/*.tar.gz", "checksums.txt"]
 upload_to_vcs_release = true