Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update release docs #541

Merged
merged 5 commits into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,45 @@
December 23, 2024
=================

Release 1.5.1

- General
- Various bug fixes
- Fixed a bug where `-l` option didn't work in lcm-logger
- Fixed a bug where not all compiler flags were being set
- Fixed a command in the post-install instructions for linux
- Fixed various compiler warnings
- Added `CONTRIBUTING.md`
- Added documentation for installing LCM
- Build system
- No longer built with `-Werror` flags by default
- Builds with release flags by default
- Installed version of `libchar-2d` will be used if possible, rather than always building from
source
- Encoding no longer needs to be set in locale (e.g. the `LANG` environment variable) in order
to build the Java component
- Finding Glib with pkgconfig is now supported
- Added a missing library for lcm-lua on Windows
- Added meson build system support for some components
- Python
- Minimum required version is 3.7
- `EventLog` now supports a Path argument, rather than just a string
- Added PEP-517 support (users can now `pip3 install .`)
- New wheels uploaded to PyPi, which support for newer versions of Python, macOS, and musl-based
linux (like Alpine)
- Typing information now supported via a stub file
- SIGINT no longer produces an exception when shutting down LCM executables installed via a
wheel
- lcm-gen
- Python output uses absolute (package-level) import paths where possible rather than relative
import paths
- More comments are included in the generated output for C, C++, Python, and Java
- The version of lcm-gen is now included in the output
- Python output now uses the `@staticmethod` decorator rather than `= staticmethod()`
- Python output now exports symbols using Python's redundant alias convention
- lcm-logger
- Added `--disk-quota` option

April 19, 2023
==============

Expand All @@ -16,7 +58,7 @@ This is primarily a bugfix and maintenance release.
- Location has moved from https://lcm-proj.github.io/ to https://lcm-proj.github.io/lcm/
- Windows support
- Moved from supporting Visual Studio to supporting a MSYS2 MGW64 environment
- Java
- Java
- Version 1.8 or later is now required

August 30, 2018
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ feedback and involvement on new features.
* Java
* Lua
* MATLAB
* Python (3.6 and later)
* Python (3.7 and later)

## Unmaintained languages

Expand Down
2 changes: 1 addition & 1 deletion WinSpecific/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ the necessary dependencies, you can run:

```shell
pacman -S pactoys git make
pacboy -S git make toolchain cmake glib2 gtest python-pip
pacboy -S make toolchain cmake glib2 gtest python-pip
```

## Java
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Supported platforms / languages
* Java
* Lua
* MATLAB
* Python (3.6 and later)
* Python (3.7 and later)

Forks
========
Expand Down
8 changes: 6 additions & 2 deletions docs/release_checklist
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@
b. Name the release title "vX.Y.Z"
c. Add release notes from the NEWS file

# Notify the mailing list
# PyPi Release

1. Send e-mail to lcm-users@googlegroups.com
1. Download all wheels generated from CI job from the latest push
2. Test a macOS wheel and a Linux wheel
- Run `test/python/test_python_module.py`
- Run `lcm-logplayer-gui`
3. Upload all wheels to PyPi
Loading