diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 43462ff..e22ae09 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -165,13 +165,17 @@ jobs: name: distribution path: dist - # What was written when the tag was made is what the release says. + # The release says what release_notes/.md says, or else what was written + # when the tag was made, or else what GitHub generates from the merged pull requests. - name: '🏷️ Create the release' env: GH_TOKEN: ${{ github.token }} run: | + release_notes="release_notes/${{ needs.version.outputs.version }}.md" git tag -l --format='%(contents)' "$GITHUB_REF_NAME" > notes.md - if [ -s notes.md ]; then + if [ -f "$release_notes" ]; then + notes=(--notes-file "$release_notes") + elif [ -s notes.md ]; then notes=(--notes-file notes.md) else notes=(--generate-notes) diff --git a/release_notes/0.1.0.md b/release_notes/0.1.0.md new file mode 100644 index 0000000..677e3f6 --- /dev/null +++ b/release_notes/0.1.0.md @@ -0,0 +1,5 @@ +## Known issues + +- **Linux, standalone Python builds** (for example python-build-standalone): tkinter fails in the simulator, so the dialogs and plots of the `embedded_python` example fail with `libtcl9tk9.0.so: cannot open shared object file` or `Cannot find a usable init.tcl`. Fixed by #3, for the next release. +- **Windows**: a matplotlib Tk window crashes the simulator when the simulator has a Tcl of its own with a different version than Python's, for example NVC 1.22 (Tcl 9) with Python 3.13 or older, or Questa with Python 3.14. The cause is in Pillow and matplotlib. Workarounds: a Python with the Tcl version of the simulator, or a matplotlib backend without Tk. See #5. +- The PySimpleGUI tests of the example open dialogs and wait for an answer, so they need a display and someone to answer them.