Prepare v0.4 release #339

formatc1702 · 2024-05-05T13:32:40Z

As proposed, let's release v0.4 before integrating the large PR #251 into the dev branch.

This PR is intended to do a final check before release, to address any inconsistencies.
The obvious one would be to add the release date to the changelog.

`.gv` and `.html` files include the version number as a comment. Rebuild to avoid diffs during development

Moved metadata and options info further down, so that the core functionality (connectors, cables, connection sets) comes first.

- Use pin names instead of pin indices, until the last moment when generating the ports for the GraphViz nodes - `Harness.add_mate_pin()` now uses pin names - Remove unused `if is_arrow()` check from `Harness.connect()` - Consolidate calling of `Connector.activate_pin()` to prevent subtle bugs - Call it from `connect()` and `add_mate_pin()` - No longer call it from `create_graph()` - Misc. other tuning

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

Experiments in exporting PDF using `wkhtmltopdf` utility caused borders to disappear when set to 0.25mm, but 0.35mm renders fine

Re-add `parse_file()` for building examples bla

kvid

See my suggested changes after looking through the major changes . One of them seemed to be lost, so I had to write it again. I hope I didn't loose any other comments.

docs/CHANGELOG.md

src/wireviz/wv_colors.py

src/wireviz/DataClasses.py

src/wireviz/wv_colors.py

kvid · 2024-05-06T10:57:49Z

See my bottom question in #309 (comment) where I point out that the code to be released now only lists quite old Python versions in setup.py and our github workflow. However, I fully understand that you want to avoid including new Python versions in the last minute unless you already have experience using this codebase in that Python version and are confident it has been working for a while with different use cases.

kvid · 2024-05-08T07:38:36Z

After thinking a bit, I now believe it's best to leave the supported Python versions unchanged for this release. #251 has already such changes, and we'll get more time testing it after that is merged into dev. The workflow already test 3.8, and all later minor versions should normally be backwards compatible. I think we therefore can expect them to work with this release as well.

kvid

I assume removing the -h CLI option is not intentional.

src/wireviz/wv_cli.py

docs/CHANGELOG.md

docs/README.md

docs/CHANGELOG.md

kvid

I suggest expanding the "Installing the development version" section of README to include recommending venv by, e.g. copying commands from #251 (comment) (checking out the dev branch) and also include pip3 install isort and pip3 install black after activating .venv. It will lower the threshold for potential contributors to have a list of commands to get started.
I don't know if it makes sense to create a requirements-dev.txt like this to simplify the README description:

-r requirements.txt
isort
black

Edit: This task about installation description can of course wait unless you have a sequence of commands ready that you have used yourself and don't need testing.

src/wireviz/wv_colors.py

docs/README.md

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

formatc1702 · 2024-05-09T09:07:23Z

Thank you for your review, I have integrated most suggestions and written a comment on the ones that I didn't.

After thinking a bit, I now believe it's best to leave the supported Python versions unchanged for this release.

Agreed.

I suggest expanding the "Installing the development version" section of README [...] It will lower the threshold for potential contributors to have a list of commands to get started.

Good idea, but let's do this after the refactor is merged into dev, to avoid PRs based on the v0.4 code i.e. on the non-refactored code. A PR to update the README, using the refactored branch as a base, is no problem.

Once v0.4 is merged into master and published, I will try to cherry-pick all of your code suggestions (as far as they are still applicable) to the refactored code so we don't suffer a regression there.

Since most of the current suggestions are quite minor, would you give the OK for releasing v0.4? Then all further review/suggestion effort can be focused on the newer code. Thanks!

Remove the references in the CLI help, but keep the placeholders elsewhere in the code as a TODO

kvid · 2024-05-09T14:55:19Z

Thank's for accepting most of my suggestions.

Note that I pushed a small commit that you should approve or undo. I think it'll help users with old YAML files to get such a notice instead of something that looks like an internal error.

It's also easy to expand this later when more attributes get obsolete or changed.

formatc1702 · 2024-05-09T15:54:01Z

It's a good idea. Let's see if this can be maintained/updated for future changes; for now it should at least catch the big issues, which is already helpful!

formatc1702 · 2024-05-09T15:56:04Z

I am traveling and will be able to merge/publish next week.

kvid

I just discovered two of the new examples have "0 m" as cable quantity in the BOM because of missing cable length attributes. If this is an unintentional error, it's very easy to correct before the release, but It's no big deal to me if you intentionally leave it as it is.

Maybe a waning about each zero cable/bundle length in the harness could be a future feature?

examples/ex11.yml

examples/ex13.yml

formatc1702 · 2024-05-12T11:34:52Z

Let's leave the examples as they are.
For the future, not specifying any length could indeed trigger a warning, and at the same time, the BOM entry should not list 0m, but simply stay blank.

formatc1702 · 2024-05-12T11:55:27Z

v0.4 is released 🎉 The next step is somehow integrating #251 into dev...

kvid · 2024-05-12T21:01:35Z

@formatc1702 wrote:

v0.4 is released 🎉

Congratulations! Thank's a lot for your effort.

The next step is somehow integrating #251 into dev...

First, we need to include all the latest commits from the release into dev. Do you prefer merging master into dev or rebasing dev on top of master? In the latter alternative, do we risk auto-closing other PRs due to force-pushing their base branch?

After that step, we should rebase the #251 branch on top of the updated dev.

formatc1702 · 2024-05-17T09:21:37Z

Another alternative would be to cherry pick some changes that went into master but not into dev (such as your latest suggestions), or simply adding the refactored equivalent of the change by hand.

I don't think a rebase/merge makes sense since a lot of the changes are not 1:1 applicable to the refactored code anyway. This way, we avoid weird cross-merges as well.

formatc1702 and others added 30 commits October 11, 2021 22:08

Bump version to 0.4-dev

4f4d63f

Bump version in generated files

a6efd28

`.gv` and `.html` files include the version number as a comment. Rebuild to avoid diffs during development

Squash feature/mate+autogenerate branch

8ea8248

Resolve edge case of empty HTML tables

2a62dae

Resolve component level mate not revealing connection count

2d701ee

Update syntax description (autogeneration, arrows)

9ccd55e

Moved metadata and options info further down, so that the core functionality (connectors, cables, connection sets) comes first.

Move selected test files to examples directory

db6f2da

Fix duplicates in syntax.md after rebase

50ea7f5

Fix bug of arrows using the wrong port IDs

02a800a

Simplify code

f0b63de

Implement template-based HTML output

eae2694

Add template metadata to demo02.yml

95defd0

Add type hint

960f20e

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

Apply fontname and bgcolor to output HTML

36195e1

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

Consolidate code for replacing HTML placeholders

5bed6de

Implement fontname and bgcolor(WIP) replacement

0296310

Use regex-based replacement

406bdd3

Update smart_file_resolve()

b2a2770

Apply suggestions from code review

aa9278d

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

Apply suggestions from code review

a59f96a

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

Equalize line weights and simplify CSS

b513051

Experiments in exporting PDF using `wkhtmltopdf` utility caused borders to disappear when set to 0.25mm, but 0.35mm renders fine

Replace os.path with pathlib.Path where used

00be474

Add explanatory comment

a85ad89

Simplify main()

35e89d4

Simplify and clean up setup.py

8e59a14

Add wv_cli.py, add Click requirement, change entry point

a810bd5

Implement working proof of concept

1df45ab

Remove unneeded code from wireviz.py

19481b2

Re-add `parse_file()` for building examples bla

Add CLI help strings

77f668e

formatc1702 mentioned this pull request May 5, 2024

Prepare v0.4 release #338

Closed

formatc1702 requested a review from kvid May 5, 2024 13:34

formatc1702 added 2 commits May 5, 2024 15:34

Rebuild examples

b9357f3

Apply black

55c6ab5

kvid requested changes May 6, 2024

View reviewed changes

kvid mentioned this pull request May 6, 2024

Python version update #309

Open

kvid requested changes May 8, 2024

View reviewed changes

src/wireviz/wv_cli.py Outdated Show resolved Hide resolved

docs/CHANGELOG.md Show resolved Hide resolved

docs/README.md Show resolved Hide resolved

kvid reviewed May 8, 2024

View reviewed changes

docs/CHANGELOG.md Outdated Show resolved Hide resolved

kvid requested changes May 9, 2024

View reviewed changes

src/wireviz/wv_colors.py Outdated Show resolved Hide resolved

formatc1702 commented May 9, 2024

View reviewed changes

docs/README.md Outdated Show resolved Hide resolved

Apply suggestions from code review

591ae7f

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

formatc1702 and others added 2 commits May 9, 2024 14:10

Remove references for unsupported output formats

50d2917

Remove the references in the CLI help, but keep the placeholders elsewhere in the code as a TODO

Add check for outdated connector attributes

9b2b22d

kvid previously approved these changes May 9, 2024

View reviewed changes

kvid reviewed May 11, 2024

View reviewed changes

examples/ex11.yml Show resolved Hide resolved

examples/ex13.yml Show resolved Hide resolved

Add v0.4 release date

33e5ef6

formatc1702 dismissed kvid’s stale review via 33e5ef6 May 12, 2024 11:36

formatc1702 merged commit 954c4f5 into master May 12, 2024
4 checks passed

formatc1702 deleted the release/v0.4-rc2 branch May 12, 2024 11:37

martinrieder mentioned this pull request May 13, 2024

WireViz 0.4 changed CLI parameters nanangp/vscode-wireviz-preview#5

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare v0.4 release #339

Prepare v0.4 release #339

formatc1702 commented May 5, 2024

kvid left a comment

kvid commented May 6, 2024

kvid commented May 8, 2024

kvid left a comment

kvid left a comment •

edited

Loading

formatc1702 commented May 9, 2024 •

edited

Loading

kvid commented May 9, 2024 •

edited

Loading

formatc1702 commented May 9, 2024

formatc1702 commented May 9, 2024

kvid left a comment •

edited

Loading

formatc1702 commented May 12, 2024

formatc1702 commented May 12, 2024

kvid commented May 12, 2024

formatc1702 commented May 17, 2024 •

edited

Loading

Prepare v0.4 release #339

Prepare v0.4 release #339

Conversation

formatc1702 commented May 5, 2024

kvid left a comment

Choose a reason for hiding this comment

kvid commented May 6, 2024

kvid commented May 8, 2024

kvid left a comment

Choose a reason for hiding this comment

kvid left a comment • edited Loading

Choose a reason for hiding this comment

formatc1702 commented May 9, 2024 • edited Loading

kvid commented May 9, 2024 • edited Loading

formatc1702 commented May 9, 2024

formatc1702 commented May 9, 2024

kvid left a comment • edited Loading

Choose a reason for hiding this comment

formatc1702 commented May 12, 2024

formatc1702 commented May 12, 2024

kvid commented May 12, 2024

formatc1702 commented May 17, 2024 • edited Loading

kvid left a comment •

edited

Loading

formatc1702 commented May 9, 2024 •

edited

Loading

kvid commented May 9, 2024 •

edited

Loading

kvid left a comment •

edited

Loading

formatc1702 commented May 17, 2024 •

edited

Loading