-
Notifications
You must be signed in to change notification settings - Fork 425
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
Extend Makefile with installation and test targets #2303
Comments
Good idea. It might be reasonable to set up a bunch of small changes and have 1.1.12 come out only a few weeks after 1.1.11. |
I think right after 1.1.11 there should be most of the refactoring, cleanup and modernization tickets tackled. After that new features can be added and tests can be written in parallel at any time. |
This sounds like a good plan. Tackle a bunch of small-to-medium tasks to clean up the code and set up better infrastructure. Then 1.1.12 can be pushed out. |
In addition to that change, the setup instructions need to be revised, restructured and simplified.
As minor support for macOS was added and Windows might be supported as well, the setup instructions need to be split according to OS. They should be clear for an average user, who is able to find the shell and know their operating system. (optional) With a small troubleshooting section, this should also lead to fewer/shorter support request. Install from source using MakefileWith this change, the installation for Ubuntu using the latest source code should reduce to the command Developers run it with additional parameters to install test dependencies etc. |
Refactor setup steps to unify commands between Linux and macOS. Move bash commands into Makefile for consistency and enable local execution of GitHub CI commands corresponding Makefile targets. Fixes pwr-Solaar#2303
Yes, more makefile entries would be useful. |
I don't know other distributions like Fedora, but it should be easy for developers to extend that Makefile and make Solaar installation for development a no brainer. In the end the Makefile could even be OS agnostic by detecting it with |
Refactor setup steps to unify commands between Linux and macOS. Move bash commands into Makefile for consistency and enable local execution of GitHub CI commands corresponding Makefile targets. Install on Ubuntu: make install_ubuntu Install on Ubuntu for development: make install_ubuntu PIP_ARGS=."[test]" Fixes pwr-Solaar#2303
* Show pytest coverage in GitHub CI tests Related #1097 * Extend Makefile with installation and test targets Refactor setup steps to unify commands between Linux and macOS. Move bash commands into Makefile for consistency and enable local execution of GitHub CI commands corresponding Makefile targets. Install on Ubuntu: make install_ubuntu Install on Ubuntu for development: make install_ubuntu PIP_ARGS=."[test]" Fixes #2303 * Improve name of GitHub test actions Related #2303 * Upgrade GitHub actions to Node.js 20 Replaces deprecated Node.js 16 actions. Related #2256, #2284
Information
Is your feature request related to a problem? Please describe.
The Solaar installation with all its dependencies (pip, apt, udev etc.) is cumbersome. Although some setup steps for GItHub CI exists, they are not usable for local setup of Solaar.
Describe the solution you'd like
Move the setup commands into a Makefile and use the targets in GitHub workflow files. Thus, the commands are in a single place and also usable for local setups.
Additional context
This extends #2263
The text was updated successfully, but these errors were encountered: