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

Introduce a script/tool for checking Renovate prerequisite versions/memory size #11617

Open
olegkrivtsov opened this issue Sep 7, 2021 · 5 comments
Labels
priority-4-low Low priority, unlikely to be done unless it becomes important to more people type:refactor Refactoring or improving of existing code

Comments

@olegkrivtsov
Copy link
Contributor

What would you like Renovate to be able to do?

While installing Renovate on my Ubuntu 20.04 virtual machine and Ubuntu 18.04 VM, I faced with some issues:

  • GIT version was outdated on Ubuntu 18.04
  • memory size was insufficient of Ubuntu 20.04 (1GB)

For me as a newbie, it wasn't obvious how to fix those issues, so I had to submit a bug report.

Suggestion:

Introduce a bash/python script which would check the following (but not limited):

  • GIT version is compatible
  • C++ compiler is compatible
  • TypeScript version is compatible
  • memory (RAM) size is sufficient
  • maybe something else, e.g. disk space is enough

Add a paragraph to the Renovate documentation suggesting running this tool before/after installation to check prerequisites. I've used a script like that with a PHP framework called Yii2, and it was really useful.

If you have any ideas on how this should be implemented, please tell us here.

I guess a Python or Bash script would be sufficient. It could be placed to the root directory of the Renovate installation. The user would just run the script to check prerequisites were installed correctly.

Is this a feature you are interested in implementing yourself?

Yes

@olegkrivtsov olegkrivtsov added priority-5-triage status:requirements Full requirements are not yet known, so implementation should not be started type:feature Feature (new functionality) labels Sep 7, 2021
@viceice viceice removed the type:feature Feature (new functionality) label Sep 7, 2021
@olegkrivtsov
Copy link
Contributor Author

Additional note:

Please maybe mention in your documentation which Git versions are acceptable. Right now it just says "Git" without mentioning the compatible versions of it: https://github.com/renovatebot/renovate/blob/main/docs/development/local-development.md#prerequisites

@viceice
Copy link
Member

viceice commented Sep 7, 2021

  • typescript versions is installed by yarn, so no need to validate
  • C++ compiler isn't needed
  • Script should work for all platforms (linux / windows / macos)
  • Script should be in tools directory
  • I think it should be a simple esm js file, check tools directory for samples

@viceice viceice mentioned this issue Sep 7, 2021
6 tasks
@viceice
Copy link
Member

viceice commented Sep 7, 2021

related to #11167

@HonkingGoose HonkingGoose added the type:refactor Refactoring or improving of existing code label Sep 8, 2021
@HonkingGoose
Copy link
Collaborator

I think @viceice already said what the "recipe" is for the changes. So I'd say we're status:ready and can maybe assign @olegkrivtsov to this issue, as they volunteered to make the feature for us?

@rarkins
Copy link
Collaborator

rarkins commented Oct 18, 2021

Could this may be be renovate --diagnose? So that it doesn't need to be a new installed binary and also can be used even when renovate is installed via npm.

@rarkins rarkins added priority-4-low Low priority, unlikely to be done unless it becomes important to more people status:ready and removed priority-5-triage status:requirements Full requirements are not yet known, so implementation should not be started labels Oct 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-4-low Low priority, unlikely to be done unless it becomes important to more people type:refactor Refactoring or improving of existing code
Projects
None yet
Development

No branches or pull requests

4 participants