-
Notifications
You must be signed in to change notification settings - Fork 42
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
Build CLI: Configurations on User Level & CI Improvements #2129
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AmmarAbouZor
force-pushed
the
build_cli_config
branch
2 times, most recently
from
October 23, 2024 07:37
b6c0285
to
b662bc4
Compare
@DmitryAstafyev The default shell will be retrieved from SHELL environment variable. |
AmmarAbouZor
force-pushed
the
build_cli_config
branch
from
October 23, 2024 09:45
25d7309
to
49722fa
Compare
marcmo
reviewed
Oct 23, 2024
AmmarAbouZor
force-pushed
the
build_cli_config
branch
from
October 23, 2024 11:12
49722fa
to
d4615fe
Compare
Test passes on Windows |
AmmarAbouZor
force-pushed
the
build_cli_config
branch
from
October 29, 2024 11:53
d4615fe
to
3645aee
Compare
* Implement user configurations as singleton with their load method * Provide an enum to represent the shell running by users with methods to provide command to run process in the selected shell. * Replace the implementation global commands function with the one from the user configurations * Extend benchmarks configurations error message to avoid confusion between different kinds of configurations. * Documentations
* Add commands to print the path of the configurations file, printing the defaults to stdout and writing the default to configuration file if not exist * Remove the part of creating the needed directories for chipmunk and build CLI home directories.
* Ensure that the configured shell exists on the system before running any further commands. * Change method name from cmd to bin
* UI mode will be loaded from user configuration if not specified as CLI argument * Release command doesn't consider the UI mode in configuration file.
Use default values when configs don't exist to avoid forcing the users to specify all options
* Default shell is platform specific and they must not be shown on platform where are not supported (like `cmd` on Linux) * Set default shell to `zsh` on MacOs. * Default shell is installed by default and doesn't need an extra check, which can be faulty since `sh` doesn't provide a version argument
* Add test for user configuration commands * Change command naming alias
* Use environment variables to figure out the default shells on unix-based platforms * Use `cmd` on Windows
* Update README file with configuration section * Increase tool version & Update Changelog * Move use statement to fix warning on Windows
AmmarAbouZor
force-pushed
the
build_cli_config
branch
from
October 31, 2024 07:56
3645aee
to
ceda34e
Compare
Build CLI tool will automatically pick all targets that have tests if no target is specified. This will fix ignoring targets the not mentioned targets like CLI
Installing using cargo will ensure it will work on all platform in addition to caching it with the action cargo-cache
* Print logs of errors to stderr with UI mode `immediate` to improve highlighting the errors within GitHub actions * Add missing copy trait to small enum
Show logs immediately on CI checks
AmmarAbouZor
changed the title
Build CLI: Configurations on User Level
Build CLI: Configurations on User Level & CI Improvements
Oct 31, 2024
* In immediate mode there is no other indicator that the jobs has been skipped without progress bars and reports
* Use cargo to install wasm-pack packages to ensure cross-platform support and utilize caching with cargo-cache action
Timeout has been implemented within CI checks themselves instead of building them inside the CLI tool itself |
DmitryAstafyev
approved these changes
Nov 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes #2119
This PR closes #2140
This PR closes #2141
It provides a way for the users to configure their environment and preferences in a file in Chipmunk home directory to be loaded and used by the build CLI tool
It Provides fixes improvements in fixes to run CI checks which are described in the linked issues.
The following configuration are provided currently:
Roadmap:
stdout
and to the configuration file.wasm-pack
stderr
inimmediate
mode.immediate
mode.