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

Add dependency check to Makefile #124

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Aurelian-Shuttleworth
Copy link

A new Bash script dependancy_check.sh has been added to ensure that the minimum required Bash version is used and that required commands used by generate are available. This script is now called in the Makefile as part of the check_dependencies task. This aims to prevent errors due to incompatible Bash versions or missing commands.

After encountering some minor inconvenience debugging why then generate.sh script was failing, I added this script to ensure others don't waste any time.

Also, minor clean up of the Development readme.

A new Bash script `dependancy_check.sh` has been added to ensure that the minimum required Bash version is used. This script is now called in the Makefile as part of the `check_dependencies` task. This aims to prevent errors due to incompatible Bash versions.
The `dependancy_check.sh` script has been expanded to improve the verification process. It not only checks the running bash version for compatibility, but also ensures that a set list of commands are available before proceeding. This eliminates potential breakdowns due to missing dependencies or unsupported bash versions.
Reshaped the DEVELOPMENT.md file to provide thorough and more explicit instructions. Each section is now easily accessible and comprehensible, eliminating any potential ambiguity for the user. This streamlines the development process by clearly laying out instructions for checking dependencies, generating Jsonnet libraries and documents, as well as understanding usage of the Grafonnet-base library and examples.
@CLAassistant
Copy link

CLAassistant commented Sep 22, 2023

CLA assistant check
All committers have signed the CLA.

@Duologic
Copy link
Member

Thanks of this, the DEVELOPMENT.md is totally out-of-date and requires a proper rewrite, perhaps we can do that in a separate PR.

@Duologic
Copy link
Member

I've made updates to the Makefile in #129 and rewritten DEVELOPMENT.md in #133, please have a look at these.

@Duologic
Copy link
Member

I've been thinking about this, perhaps it would be much safer to pour this all into a container image rather than expecting a local development environment. WDYT?

@Aurelian-Shuttleworth
Copy link
Author

@Duologic I agree moving to a dev container would be a much better way to handle it.

May I suggest creating a Dev container or multiple?

Plus makes for great integration in most popular IDE.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants