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

docs(check-prerequisites): prerequisites recipe #15014

Merged
merged 5 commits into from
Feb 5, 2024
Merged

Conversation

sushi30
Copy link
Contributor

@sushi30 sushi30 commented Feb 2, 2024

Describe your changes:

Added a script the goes over the prerequsities checklist and validates they all exist and are on supported versions.

  • added scripts/check_prerequisites.sh.
  • added usage in docs.
  • added prerequisites to Makefile.

Examples

Sucessful Run

✓ Python version 3.9.18 is supported.
✓ Docker version 24.0.7 is supported.
✓ Java version 17.0.10 is supported.
✓ Maven version 3.9.6 is supported.
✓ jq version 1.7.1 is supported.
✓ Node version v18.19.0 is supported.
✓ Yarn version 1.22.21 is supported.
✓ ANTLR version 4.9.2 is supported.
✓ All prerequisites are met.

Unsupported Version

✗ ERROR: Python version 3.12.1 is not supported. Supported versions are: 3.9 3.10 3.11
✓ Docker version 24.0.7 is supported.
✓ Java version 17.0.10 is supported.
✓ Maven version 3.9.6 is supported.
✓ jq version 1.7.1 is supported.
✓ Node version v18.19.0 is supported.
✓ Yarn version 1.22.21 is supported.
✓ ANTLR version 4.9.2 is supported.
✗ ERROR: Some prerequisites are not met.
make: *** [prerequisites] Error 1

Type of change:

  • Documentation

Checklist:

  • I have read the CONTRIBUTING document.
  • My PR title is Fixes <issue-number>: <short explanation>
  • I have commented on my code, particularly in hard-to-understand areas.
  • For JSON Schema changes: I updated the migration scripts or explained why it is not needed.

Copy link

github-actions bot commented Feb 2, 2024

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

@harshach
Copy link
Collaborator

harshach commented Feb 2, 2024

@sushi30 this is awesome!! Thank you

Copy link

sonarcloud bot commented Feb 2, 2024

Quality Gate Passed Quality Gate passed for 'open-metadata-ingestion'

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@pmbrull pmbrull merged commit 93c8ce3 into main Feb 5, 2024
28 checks passed
@pmbrull pmbrull deleted the check-prerequisites branch February 5, 2024 06:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation safe to test Add this label to run secure Github workflows on PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants