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 jq as an install requirement #621

Open
rocketnova opened this issue Jun 5, 2024 · 6 comments
Open

Add jq as an install requirement #621

rocketnova opened this issue Jun 5, 2024 · 6 comments
Labels
scope: documentation Improvements or additions to documentation type: devex Developer experience workflow: self-contained Doesn't require a lot of context to pick up

Comments

@rocketnova
Copy link
Member

We originally wanted to keep the installation requirements for platform repos to a minimum. However, as the project has grown, at the current stage of maturity, it would be really useful to include jq as a lightweight dependency for our scripts.

Options to consider:

  • We set it as a dependency in the README and, in our instructions, assume that users have jq already installed
  • We could explicitly include instructions to install jq as one of the set up instructions, such as in set-up-infrastructure-tools
  • We could bundle it into an executable
  • We could assume the user has docker installed and run jq inside a docker container

Reference:

@rocketnova
Copy link
Member Author

My recommendation:

We set it as a dependency in the README and, in our instructions, assume that users have jq already installed

I think this is the initial lightest weight option. We can always revisit in the future if/when we change the way we handle scripting/template lifecycle management.

@rocketnova rocketnova added the type: devex Developer experience label Jun 5, 2024
@lorenyu
Copy link
Contributor

lorenyu commented Jun 5, 2024

One of the first two options seems preferable to me.

@lorenyu lorenyu added scope: documentation Improvements or additions to documentation workflow: self-contained Doesn't require a lot of context to pick up labels Jun 5, 2024
@KevinJBoyer
Copy link
Contributor

FWIW I think jq is already an implicit dependency, I see it in bin/check-database-roles.sh and create-or-update-database-roles.sh

@rocketnova
Copy link
Member Author

I think that script used in the AWS Lambda, which isn't part of the template scripting run outside of the lambda, such as the install script or the update template script.

@KevinJBoyer
Copy link
Contributor

My understanding is that script runs locally to invoke the AWS Lambda (and jq is part of what's being run locally)

@rocketnova
Copy link
Member Author

@KevinJBoyer Ah thank you. You're correct. We should definitely make the dependency on jq explicit then and we can start using it more liberally in our other scripts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: documentation Improvements or additions to documentation type: devex Developer experience workflow: self-contained Doesn't require a lot of context to pick up
Projects
None yet
Development

No branches or pull requests

3 participants