Skip to content

Fix arcade.version.VERSION conversion from GitHub CI format#2569

Merged
pushfoo merged 11 commits intodevelopmentfrom
fix-arcade.VERSION
Feb 17, 2025
Merged

Fix arcade.version.VERSION conversion from GitHub CI format#2569
pushfoo merged 11 commits intodevelopmentfrom
fix-arcade.VERSION

Conversation

@pushfoo
Copy link
Member

@pushfoo pushfoo commented Feb 17, 2025 •
edited
Loading

TL;DR: Stop swallowing last . + add extensive tests, error reporting, and doc

Why?

Release time is not a fun time to be debugging weird issues:

  1. cspotcode is right, the current code is broken:

    The version numbering bug will publish it as a minor bump instead of a patch bump

  2. We should verify that our release-critical code does what it says
  3. The code should tell us what went wrong during build, not ERROR: Unable to load version number via './VERSION'

What?

  1. Explain what's in the can and why
    • Our release process
    • A ctrl-clickable link to the version bump GH action's config YAML
  2. Aggressive tests covering various possible typos or misconfigurations
  3. Explain what went wrong in more detail if/when it does

Bonus: special-case "3.0.0" to "3.0" to avoid churn in bookmarks / etc change detection due to the title changing.

pushfoo added 11 commits February 16, 2025 21:20
@pushfoo
Fix converting from GH Action CI to Py version
45f493a 
* Use explicitly clear regex approach to read version string

* Add tests for specified behavior to our CI

* Document the process clearly with a link to GH action config file
@pushfoo
Increase exception specificity and test detail
14ec21c
@pushfoo
Prevent dev panic by including failure reason in the error logs
89c1fe9
@pushfoo
Add test cases to cover more bad values (hex + bad dev_preview numbers)
e600159
@pushfoo
Remove per-field check for now
67308f9
@pushfoo
Fix missing name + formatting
06e0871
@pushfoo
Placate Henry Ford's ghost (black formatter)
ea6f26a
@pushfoo
Proofreading and style fixes
2627f19 
* Fix black formatter putting two f-strings onto a line w/o merging them

* Fix typos

* Add a Final[str] annotation to the VERSION constant

* Cut down and rearrange the top-level docstring for clarity
@pushfoo
Extended mode regex formatting to make it pretty
e717857
@pushfoo
Update comment phrasing to be extra clear
1e13668
@pushfoo
Add special-casing to avoid churn on page titles in 3.0 / latest
058c87d
@pushfoo pushfoo merged commit dd2b417 into development Feb 17, 2025
9 checks passed
@pushfoo pushfoo mentioned this pull request Feb 17, 2025
Merged
@pushfoo
Copy link
Member Author

pushfoo commented Feb 17, 2025

In case anyone asks why I merged this already:

  1. It fixes a bug
  2. It adds unit tests future implementations with even better reporting can use
  3. It sets up cleaning more things from doc/conf.py

@eruvanos eruvanos deleted the fix-arcade.VERSION branch February 17, 2025 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@pushfoo