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

[DOC] - terraform is needed to run the pre-commit hooks #308

Open
1 task done
pmeier opened this issue Apr 21, 2023 · 4 comments
Open
1 task done

[DOC] - terraform is needed to run the pre-commit hooks #308

pmeier opened this issue Apr 21, 2023 · 4 comments
Labels
area: documentation 📖 good first issue Good for newcomers type: maintenance 🛠 Day-to-day maintenance tasks

Comments

@pmeier
Copy link
Member

pmeier commented Apr 21, 2023

Preliminary Checks

Summary

The terraform_fmt hook needs terraform to be installed in the current environment to run. This is mentioned in the requirements for this hook. This is not mentioned in the code contribution guidelines.

Might be related to #307, since there seems to be some information missing regarding the development environment.

Steps to Resolve this Issue

Add terraform as part of the development requirements

@pavithraes pavithraes added type: maintenance 🛠 Day-to-day maintenance tasks needs: discussion 💬 Needs discussion with the rest of the team labels Apr 22, 2023
@pavithraes
Copy link
Member

Thanks for reporting. I don't see terraform in our previous environment-dev.yml either, but we can add it to the contributor guide to install separately.

@iameskild What do you think?

@iameskild
Copy link
Member

Adding Terraform to the contributor guide makes sense to me :)

@pmeier
Copy link
Member Author

pmeier commented May 3, 2023

Note that it can also be installed with conda install -c conda-forge terraform. Might be helpful for folks that use a conda env anyway so they don't have to install systemwide.

@pmeier
Copy link
Member Author

pmeier commented May 3, 2023

I just realized this is why we have skip for pre-commit CI and run this is a separate CI workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 good first issue Good for newcomers type: maintenance 🛠 Day-to-day maintenance tasks
Projects
Status: Todo 📬
Status: New 🚦
Development

No branches or pull requests

3 participants