Merge pull request winpython#2101 from stonebig/changelog-name-carries-release-level

Put the release level in the changelog name

Author: stonebig

.github/actions/publish-winpython/action.yml

@@ -13,6 +13,10 @@ inputs:
     required: true
   winpy_ver2:
     required: true
+  release_level:
+    required: false
+    default: ""
+    description: 'b1, rc2, ... appended to winpy_ver2 in the changelog name'
   dotwheelhouse:
     required: true
   winpy_requirements_whl:
@@ -51,8 +55,11 @@ runs:
         $env:PYTHONIOENCODING="utf-8"
         $pythonExe = Join-Path "${{ inputs.build_location }}" "python\python.exe"
 
-        # Markdown Metadata
-        $destfile_md = "publish_output\WinPython${{ inputs.winpy_flavor }}-${{ inputs.winpy_arch }}bit-${{ inputs.winpy_ver2 }}.md" 
+        # Markdown Metadata. The release level is part of the name: a b1 and the
+        # final it becomes share a winpy_ver2, so without it the beta's package
+        # list occupies the final's file. 3.15.0.5b1 is a PEP 440 version, and
+        # sorts where find_previous_version needs it to.
+        $destfile_md = "publish_output\WinPython${{ inputs.winpy_flavor }}-${{ inputs.winpy_arch }}bit-${{ inputs.winpy_ver2 }}${{ inputs.release_level }}.md"
         & $pythonExe -m wppm -md | Out-File -FilePath $destfile_md -Encoding utf8
         gc $destfile_md
 

.github/workflows/build_winpython_cycle.yml

@@ -50,6 +50,7 @@ jobs:
     outputs:
       pandoc_source: ${{ steps.cfg.outputs.pandoc_source }}
       pandoc_sha256: ${{ steps.cfg.outputs.pandoc_sha256 }}
+      release_level: ${{ steps.cfg.outputs.release_level }}
       release_tag: ${{ steps.cfg.outputs.release_tag }}
       matrix: ${{ steps.cfg.outputs.matrix }}
     steps:
@@ -158,6 +159,7 @@ jobs:
           winpy_arch: ${{ env.WINPYARCH }}
           winpy_ver: ${{ env.WINPYVER }}
           winpy_ver2: ${{ env.WINPYVER2 }}
+          release_level: ${{ needs.config.outputs.release_level }}
           dotwheelhouse: ${{ env.dotwheelhouse }}
           winpy_requirements_whl: ${{ matrix.leg.requirements_wheels }}
           format_zip: ${{ matrix.leg.formats.zip }}

tests/test_cycle_config.py

@@ -260,6 +260,19 @@ def test_publishing_is_gated_both_ways(self, workflow_text):
         assert "if: ${{ inputs.publish }}" in workflow_text
         assert "if: ${{ !inputs.publish }}" in workflow_text
 
+    def test_the_changelog_name_carries_the_release_level(self, workflow_text):
+        """A beta and the final it becomes share a ver2.
+
+        Without the level in the name, a b1's package list is written to the
+        file the final release wants, and `changelogs/` briefly describes a
+        beta under the final's name. The level has to reach the composite
+        action for that, so both halves are checked.
+        """
+        assert "release_level: ${{ needs.config.outputs.release_level }}" in workflow_text
+        action = (REPO / ".github/actions/publish-winpython/action.yml").read_text(encoding="utf-8")
+        assert re.search(r"^  release_level:$", action, re.MULTILINE), "action input is missing"
+        assert "${{ inputs.winpy_ver2 }}${{ inputs.release_level }}.md" in action
+
     def test_the_release_tag_is_never_taken_from_a_dispatch_input(self, workflow_text):
         """One source of truth: the cycle file. An input would let them disagree."""
         assert "inputs.release_tag" not in workflow_text

winpython/build_winpython.py

@@ -309,9 +309,13 @@ def main():
     generate_lockfiles(target_python, winpydirbase, args.constraints, args.find_links, file_postfix)
 
 
-    log_section(f"🙏 Step 7: generate changelog") 
-    mdn = f"WinPython{args.flavor}-{args.arch}bit-{winpyver2}.md"
-    out = f"WinPython{args.flavor}-{args.arch}bit-{winpyver2}_History.md"
+    log_section(f"🙏 Step 7: generate changelog")
+    # the release level belongs in the name: a b1 and the final it becomes share
+    # a winpyver2, so without it the beta's package list occupies the final's
+    # file. 3.15.0.5b1 is a PEP 440 version, and sorts where it should.
+    changelog_version = f"{winpyver2}{args.release_level}"
+    mdn = f"WinPython{args.flavor}-{args.arch}bit-{changelog_version}.md"
+    out = f"WinPython{args.flavor}-{args.arch}bit-{changelog_version}_History.md"
     changelog_dir = log_dir.parent/ "changelogs"
 
     cmd = ["set", f"WINPYVER2={winpyver2}&",  "set",  f"WINPYFLAVOR={args.flavor}&",
@@ -328,7 +332,7 @@ def main():
     cmd = [str(target_python), "-X", "utf8", "-c",
         (
         "from wppm import diff;"
-        f"result = diff.compare_package_indexes('{winpyver2}', searchdir=r'{changelog_dir}', flavor=r'{args.flavor}', architecture={args.arch});"
+        f"result = diff.compare_package_indexes('{changelog_version}', searchdir=r'{changelog_dir}', flavor=r'{args.flavor}', architecture={args.arch});"
         f"open(r'{winpydirbase.parent / out}', 'w', encoding='utf-8').write(result)" 
         )]
     run_command(cmd, check=False)