https://github.com/containerbase/runinstall
https://github.com/containerbase/runinstall
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/containerbase/runinstall
- Owner: containerbase
- Created: 2023-02-04T14:36:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-03T10:59:12.000Z (over 1 year ago)
- Last Synced: 2025-04-06T13:12:28.564Z (about 1 year ago)
- Language: JavaScript
- Size: 169 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Runinstall
Runinstall is a tool that detects the project version and installs it dynamically.
Runinstall extracts version constraints of package managers, and utilizes Renovate and install-tool to generate commands to install the tool version that the project requires.
References:
1. Generate commands https://github.com/renovatebot/renovate/blob/main/lib/util/exec/containerbase.ts
2. Install tool https://github.com/containerbase/base
Runinstall Currently supported tools:
1. mvn
2. pipenv
3. poetry
4. gradle
## Logic
### Path matching
- `RUNINSTALL_ENABLE_NO_GIT`: This variable is used when running locally. if set to `true`, It allows running tool update without any git repository. it will bypass `RUNINSTALL_INCLUDES` and `RUNINSTALL_EXCLUDES`
- `RUNINSTALL_INCLUDES`: This variable indicates which repositories to detect. accepts a comma seperated list of strings for repository URLs (fallback to `RUNINSTALL_MATCH`)
- `RUNINSTALL_EXCLUDES`: This variable indicates which repositories to exclude. accepts a comma seperated list of strings for repository URLs
If `RUNINSTALL_INCLUDES` is undefined, or does not match, or `RUNINSTALL_EXCLUDES` is matched, then all logic will be skipped.
The command will be passed through to `/usr/local/bin/${cmd}`.
Example:
```
export RUNINSTALL_INCLUDES=org_a,org_b
mvn --version
```
`RUNINSTALL_MATCH` is deprecated and has been replaced by `RUNINSTALL_INCLUDES`.
### Tool name checking
If any other command than the supported tools is used, the command will exit with an error.
For local development, the command can be overridden/hardcoded with `RUNINSTALL_CMD`.
Example:
```
export RUNINSTALL_CMD=mvn
node src/index.js --version
```
### History checking
Runinstall will skip all remaining logic if the same command has been run in the same directory right immediately before.
It achieves this by writing the previous command to `/tmp/runinstall_history`.
This can be overridden by setting `RUNINSTALL_FORCE=1`, which means Runinstall will ignore the history.
### Constraint extraction
Next, Runinstall will attempt to extract constraints from the `cwd`.
### Install command generation
If no constraints were found in the previous step, Runinstall will skip install command generation and not install anything.
To override this and instruct Runinstall to install every time, set `RUNINSTALL_ALWAYS_INSTALL=1`.
Runinstall then maps constraints to install commands.
This may require access to a github.com token in order to fetch release lists.
The token is found from either:
- `.gitAccessToken` in the file system in the current directory or a parent directory, or
- From `RUNINSTALL_GITHUB_TOKEN` (used as a fallback)
### Install command execution
Runinstall will then shell out to execute each install command.
### Command delegation
Finally, runinstall will execute the desired command - passing all stdio through - before then logging the result and exiting.
## Logging
Runinstall does not log to standard output or error, because doing so will pollute the command output leading to text parsing errors.
Instead, Runinstall sends its own logs to a remote CloudWatch Log Group if configured.
Configuration:
- `RUNINSTALL_DEBUG`: If defined, logs will be output to console instead of, or in addition to, Cloudwatch
- `RUNINSTALL_KEY_ID`/`RUNINSTALL_ACCESS_KEY`: AWS credentials necessary for the remote Cloudwatch service
If all the above are undefined then Runinstall won't log a thing.
At the end of an invocation, Runinstall creates a log like the following:
```
{
"args": [
"install"
],
"cmd": "poetry",
"cwd": "/tmp/ws-scm/poetry-project",
"installCommands": [
"install-tool python 3.10.11",
"install-tool poetry 1.4.2"
],
"installSuccess": true,
"level": "info",
"message": "runinstall result",
"remote": "https://github.com/dawsonbooth/poetry-project",
"runSuccess": true,
"toolConstraints": [
{
"constraint": ">=3.8,<3.11",
"toolName": "python"
},
{
"constraint": ">=0.12",
"toolName": "poetry"
}
]
}
```