Release v0.4.1 #365

kvid · 2024-05-25T15:51:52Z

~~Should we avoid pushing these last steps to this PR branch?~~ No, they should be pushed together just before PR merge into master and creating the release? Anything missing?

Bump version to v0.4.1
Execute build_examples.py and commit generated files
Update release date in CHANGELOG
Merge release branch into master (merge commit, no rebase)
Publish release on PyPI

After the release:

Apply all release changes to dev after or together with Large scale refactoring #251 merge-in to avoid regressions (manage in separate new PR!)

To try these fixes before release, this is one method:

pip uninstall wireviz
pip install git+https://github.com/wireviz/WireViz@release/v0.4.1-rc

martinrieder · 2024-06-06T04:43:44Z

I really appreciate your bugfixing work! Issue #257 is fixed by #375, despite the discussion about strange corner cases. Thanks for adding this to the list!

kvid · 2024-06-07T15:31:14Z

@formatc1702 - I'm planning a rebase of this branch later today. Please tell me when you are finished merging in here for today, so I don't mess up your changes.

formatc1702 · 2024-06-07T16:17:12Z

Thank you for all of this. I have merged some of the simpler bugfixes, feel free to rebase.
Also, you have full permission to directly merge/rebase other fixes into the 0.4.1rc branch yourself. 👍
I will try to respond to the other new issues/PRs in the upcoming days.
I'm also fine with only updating the changelog at the end, once v0.4.1 is ready; I just added some stuff already so it wouldn't get lost, because I hadn't seen this draft PR.

formatc1702 · 2024-06-11T19:52:18Z

Thanks. Let's not add more PRs unless they really are hotfixes. Thinks like #371 are already quite deep in feature-creep territory. This one is fine but everything else needs to wait.

In Windows might OSError(errno=EINVAL) be raised instead of the already catched exceptions in some cases (depending on the Python version). Suggested fix posted by JarrettR in #344 (comment) Co-authored-by: JarrettR <[email protected]>

Specify all HTML files under templates folder to be included as package data files.

Symptom reported in #355: Unable to connect an arrow (mate) to pins higher than 1 without failing: ValueError: X is not in list Bug: The code processing mates used a mix of repeated connector look-ups and local connector variables, and one variable was used before it was assigned the correct value. Fix: The local connector variables are now both assigned initially before processing each mate, and used when processing instead of repeated connector look-ups.

Bug: Not all generated dot output could be changed by tweak entries. Seen in #325 (comment) Tweak processing must be the very last dot producing code to enable tweaking any dot output. Fix: Move all other dot producing code above Tweak processing.

The CLI handling code was redesigned for v0.4 and it seems the code to assign a default title from v0.3.1 has been messed up. This bug has not been triggered by build_examples.py due to it seems to call the parse() function differently. The output_name should be used as default title when present. This will fix the #360 bug report.

Resort module import: Co-authored-by: kvid <[email protected]>

The project was moved into the new organization 2023-05-30, but old URLs are still working due to automatic redirects by GitHub. #316 (comment)

This will e.g. enable users to replace the SVG diagram with PNG, that is needed as a work-around when the SVG output from Graphviz is not looking good. Suggested as work-around for Graphviz bug in #175 (comment)

This will enable users to replace the SVG diagram with an embedded PNG, that is an improved work-around when the SVG output from Graphviz is not looking good. Suggested as work-around for Graphviz bug in #175 (comment)

Fixes #257

Fixes #340

Raising TypeError is better than assert. (Black reformatted) Co-authored-by: Andreas Motl <[email protected]>

In Windows might OSError(errno = None) be raised instead of the already catched exceptions in some cases (depending on the Python version) Fixes #391

A number of such warnings showed up when running e.g. PYTHONWARNINGS=always python build_examples.py PYTHONWARNINGS=always wireviz ../../examples/demo0?.yml See #309 (comment) Fix: All open() calls should be in a "with open() as x" statement to ensure closing the file when exiting the block in any way. Otherwise, use the new file_read_text() or file_write_text() functions to read or write the whole utf-8 text file and closing it.

formatc1702 · 2024-07-12T12:17:55Z

docs/CHANGELOG.md

+## [0.4.1] (2024-XX-XX)
+
+### Improvements to help reported issues
+- Explain unexpeced top-level type ([#342](https://github.com/wireviz/WireViz/issues/342), [#383](https://github.com/wireviz/WireViz/pull/383))
+- Add non-empty label to reduce over-sized loops ([#286](https://github.com/wireviz/WireViz/issues/286), [#381](https://github.com/wireviz/WireViz/pull/381))
+- Improve placeholder name consistency ([#377](https://github.com/wireviz/WireViz/issues/377), [#380](https://github.com/wireviz/WireViz/pull/380))
+- Add work-around for Graphviz SVG bug ([#175](https://github.com/wireviz/WireViz/issues/175), [#371](https://github.com/wireviz/WireViz/pull/371))
+
+### Bugfixes
+
+- Avoid ResourceWarning: unclosed file ([#309 (comment)](https://github.com/wireviz/WireViz/pull/309#issuecomment-2170988381), [#395](https://github.com/wireviz/WireViz/pull/395))
+- Catch ValueError and OSError(errno=None) ([#318 (review)](https://github.com/wireviz/WireViz/pull/318#pullrequestreview-1457016602), [#391](https://github.com/wireviz/WireViz/issues/391), [#392](https://github.com/wireviz/WireViz/pull/392))
+- Avoid Graphviz error when hiding all pins ([#257](https://github.com/wireviz/WireViz/issues/257), [#375](https://github.com/wireviz/WireViz/pull/375))
+- Avoid decimal point and trailing zero for integer BOM quantities ([#340](https://github.com/wireviz/WireViz/issues/340), [#374](https://github.com/wireviz/WireViz/pull/374))
+- Update project URL references ([#364](https://github.com/wireviz/WireViz/pull/364))
+- Add missing import of embed_svg_images ([#363](https://github.com/wireviz/WireViz/pull/363))
+- Use correct default title ([#360](https://github.com/wireviz/WireViz/issues/360), [#361](https://github.com/wireviz/WireViz/pull/361))
+- Fix bugs in mate processing ([#355](https://github.com/wireviz/WireViz/issues/355), [#358](https://github.com/wireviz/WireViz/pull/358))
+- Include missing files in published package ([#345](https://github.com/wireviz/WireViz/issues/345), [#347](https://github.com/wireviz/WireViz/pull/347)) 
+- Catch OSError(errno=EINVAL) ([#344](https://github.com/wireviz/WireViz/issues/344), [#346](https://github.com/wireviz/WireViz/pull/346))


formatc1702 · 2024-07-12T12:25:49Z

Looks like this is pretty much ready.
Let's freeze this version by not adding any more bugfixes.

Is it necessary to do interactive rebase? For me, the integration of the bugfixes looks quite clean, and I'm trying to move away a bit from commit history perfectionism ;)
Otherwise, @kvid I suggest you let me know when it's done on your end by requesting a review, and I will take care of publishing.

The only note I have is: the to-do item "Bump version to v0.4.1-rc" should be "Bump version to v0.4.1" so that the generated examples bear the correct (released) version mark.

isort==5.11.5

black==23.3.0

formatc1702 · 2024-07-13T11:18:29Z

Should we avoid pushing these last steps to this PR branch? Or should they be pushed together just before PR merge into master and creating the release? Anything missing?

I've followed the same procedure as for previous releases. These steps are the last commits within the PR branch before merging into master. PyPI release will follow shortly.

formatc1702 · 2024-07-13T11:30:10Z

WireViz v0.4.1 is released on PyPI 🚀
https://pypi.org/project/wireviz/0.4.1/

formatc1702 · 2024-07-13T12:01:09Z

docs/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Change Log

-## [0.4](https://github.com/formatc1702/WireViz/tree/v0.4) (2024-05-12)
+## [0.4.1] (2024-07-13)


Noticed too late that the link to the release is missing

## [0.4.1](https://github.com/formatc1702/WireViz/tree/v0.4.1) (2024-07-13)

but no biggie, can be fixed in next release.

@formatc1702 wrote:

Noticed too late that the link to the release is missing

## [0.4.1](https://github.com/formatc1702/WireViz/tree/v0.4.1) (2024-07-13)

Remember not using the old URLs containing your personal user name formatc1702!

Another thing about the link: Now that you've created release pages for the version tags, should the version links in CHANGELOG point to the code tree for the tag (as today), or should they point to the release page for the tag? https://github.com/wireviz/WireViz/releases/tag/v0.4.1

but no biggie, can be fixed in next release.

True. However, adding a minor commit to master fixing only such meta-information (not changing any file used by the code) long before creating a new release might also be considered, as far as I can understand, but I also can accept a point of view against that...

but no biggie, can be fixed in next release.

True. However, adding a minor commit to master fixing only such meta-information (not changing any file used by the code) long before creating a new release might also be considered, as far as I can understand, but I also can accept a point of view against that...

I agree. The same would apply to the following:

Create issue templates #387

Clarify and align SYNTAX and README descriptions #406

Update deprecated GitHub Actions and add Python versions #408

No code functionality impacted, so no version bump needed.

kvid mentioned this pull request Jun 2, 2024

Not installing #366

Open

kvid marked this pull request as draft June 4, 2024 19:11

Create PR to collect changes for v0.4.1-rc

9435fc2

kvid force-pushed the release/v0.4.1-rc branch 2 times, most recently from db1e77f to ddb2cba Compare June 7, 2024 23:49

martinrieder mentioned this pull request Jun 8, 2024

[meta] Collaborator discussion #101

Open

kvid force-pushed the release/v0.4.1-rc branch from 661f3cf to 2d38267 Compare June 12, 2024 01:08

This was referenced Jun 20, 2024

Help with OS Error #391

Closed

Fix Exception Handling in _get_yaml_data_and_path(...) #392

Merged

kvid mentioned this pull request Jun 21, 2024

[query] Dot notation error in Wireviz #393

Closed

This was referenced Jun 29, 2024

[feature] Option to change connector terminology "pin", to "way" or customise #331

Open

[query] yaml input file throwing error #399

Closed

Add template files to package #347

Merged

[bug] OSError: [WinError 123] with version 0.4 #344

Closed

kvid and others added 12 commits July 5, 2024 18:16

Add package_data to to setup() call in setup.py (#347)

a89d04d

Specify all HTML files under templates folder to be included as package data files.

Add missing import of embed_svg_images (#363)

a5f91e9

Resort module import: Co-authored-by: kvid <[email protected]>

Update APP_URL (#364)

2336231

The project was moved into the new organization 2023-05-30, but old URLs are still working due to automatic redirects by GitHub. #316 (comment)

Add HTML template placeholders for filename (#371)

f474cdd

This will e.g. enable users to replace the SVG diagram with PNG, that is needed as a work-around when the SVG output from Graphviz is not looking good. Suggested as work-around for Graphviz bug in #175 (comment)

Add HTML template placeholder for diagram_png_base64 (#371)

ea26116

This will enable users to replace the SVG diagram with an embedded PNG, that is an improved work-around when the SVG output from Graphviz is not looking good. Suggested as work-around for Graphviz bug in #175 (comment)

Avoid Graphviz error when hiding all pins (#375)

6488eb5

Fixes #257

Add documentation on template separator character

088c603

Add changelog for v0.4.1 (WIP)

eed00e1

kvid and others added 5 commits July 5, 2024 18:22

Rename diagram_png_base64 to diagram_png_b64 (#371)

6ba33fb

Add link from syntax.md to HTML output templates (#371)

177eb9e

Avoid decimal point and trailing zero for integer BOM quantities (#374)

668ba72

Fixes #340

Update src/wireviz/wireviz.py (#383)

858b266

Raising TypeError is better than assert. (Black reformatted) Co-authored-by: Andreas Motl <[email protected]>

Catch OSError also with errno=None (#392)

42d10df

In Windows might OSError(errno = None) be raised instead of the already catched exceptions in some cases (depending on the Python version) Fixes #391

kvid force-pushed the release/v0.4.1-rc branch from a04ddfd to ee1bd78 Compare July 5, 2024 16:32

This was referenced Jul 6, 2024

[bug] Title not updating on html output #360

Closed

[bug] ValueError: X is not in list #355

Closed

length precision #340

Closed

kvid added 3 commits July 7, 2024 16:16

Add TODOs about utf-8 encoding/charset (#395)

ae03bd6

Update changelog

bde949b

formatc1702 reviewed Jul 12, 2024

View reviewed changes

formatc1702 mentioned this pull request Jul 12, 2024

Large scale refactoring #251

Open

5 tasks

kvid added 3 commits July 12, 2024 18:36

Update changelog a bit more

38ac237

Apply isort *.py ../../setup.py

828de3f

isort==5.11.5

Apply black *.py ../../setup.py

73f56b2

black==23.3.0

kvid requested a review from formatc1702 July 13, 2024 10:43

formatc1702 added 3 commits July 13, 2024 13:10

Bump version to 0.4.1

c73738e

Rebuild examples

a57c68a

Add v0.4.1 release date

5428646

formatc1702 marked this pull request as ready for review July 13, 2024 11:16

formatc1702 approved these changes Jul 13, 2024

View reviewed changes

formatc1702 changed the title ~~Collect changes for v0.4.1-rc~~ Release v0.4.1 Jul 13, 2024

formatc1702 merged commit 1c4fd68 into master Jul 13, 2024
4 checks passed

formatc1702 deleted the release/v0.4.1-rc branch July 13, 2024 11:23

formatc1702 reviewed Jul 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release v0.4.1 #365

Release v0.4.1 #365

kvid commented May 25, 2024 •

edited

Loading

martinrieder commented Jun 6, 2024 •

edited

Loading

kvid commented Jun 7, 2024

formatc1702 commented Jun 7, 2024 •

edited

Loading

formatc1702 commented Jun 11, 2024

formatc1702 Jul 12, 2024

formatc1702 commented Jul 12, 2024

formatc1702 commented Jul 13, 2024

formatc1702 commented Jul 13, 2024

formatc1702 Jul 13, 2024 •

edited

Loading

kvid Jul 23, 2024

martinrieder Jul 23, 2024

Release v0.4.1 #365

Release v0.4.1 #365

Conversation

kvid commented May 25, 2024 • edited Loading

martinrieder commented Jun 6, 2024 • edited Loading

kvid commented Jun 7, 2024

formatc1702 commented Jun 7, 2024 • edited Loading

formatc1702 commented Jun 11, 2024

formatc1702 Jul 12, 2024

Choose a reason for hiding this comment

formatc1702 commented Jul 12, 2024

formatc1702 commented Jul 13, 2024

formatc1702 commented Jul 13, 2024

formatc1702 Jul 13, 2024 • edited Loading

Choose a reason for hiding this comment

kvid Jul 23, 2024

Choose a reason for hiding this comment

martinrieder Jul 23, 2024

Choose a reason for hiding this comment

kvid commented May 25, 2024 •

edited

Loading

martinrieder commented Jun 6, 2024 •

edited

Loading

formatc1702 commented Jun 7, 2024 •

edited

Loading

formatc1702 Jul 13, 2024 •

edited

Loading