feat: Add env vars for install and bin args
#566
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
Resolves #562 * Add Env vars for custom binary path and custom install path * Add TOML config key for custom install path for consistency * Improve wording in resolved parameter values debugging output * Add tests for new Env vars and TOML config key * Documentation * Update https://tfswitch.warrensbox.com/usage/commandline/ accordingly * Update https://tfswitch.warrensbox.com/usage/config-files/ accordingly * Add `arch` and `log-level` TOML keys description to https://tfswitch.warrensbox.com/usage/config-files/ * Improve wording in some places
…or_install_and_bin_location
…nt()` for simplicity
…or simplicity (+ create generic mapping of params)
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for new environment variables and TOML configuration keys (including custom install path and binary path) and updates related documentation, tests, and workflows for consistency. It also refactors environment variable and configuration parsing for simplicity while updating GitHub Actions workflows to derive the Go version from go.mod.
- Updates documentation for configuration files and command line usage with new environment variable examples.
- Adds tests for the new env vars and TOML key, and refactors parameter parsing logic.
- Updates GitHub Actions workflows to use go-version-file for Go version configuration.
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| www/docs/usage/config-files.md | Updated wording and added details for using custom paths and log-levels. |
| test-data/integration-tests/test_tfswitchtoml/.tfswitch.toml | Added install key for specifying a custom install path. |
| lib/param_parsing/environment.go | Refactored environment variable parsing to iterate over paramMappings. |
| www/docs/usage/commandline.md | Updated shell command examples and added new sections for TF_LOG_LEVEL, TF_INSTALL_PATH, and TF_BINARY_PATH. |
| .github/workflows/* | Adjusted workflows to read Go version from go.mod and set minimal permissions. |
| lib/param_parsing/parameters.go, toml.go, toml_test.go | Integrated new parameter mappings and fixed testing for TOML processing. |
| lib/install.go | Minor update to log message for clarity on CPU architecture mismatches. |
…or_install_and_bin_location
MatthewJohn
reviewed
Mar 18, 2025
…e.md` as of the most recent commits that addressed PR comments
MatthewJohn
reviewed
Mar 18, 2025
MatthewJohn
approved these changes
Mar 19, 2025
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.
Resolves #561 (discussion)
Resolves #562 (issue from discussion)
archandlog-levelTOML keys description to https://tfswitch.warrensbox.com/usage/config-files/go.modinstead of explicit hard-coded version