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

Fix website tests #590

Merged
merged 3 commits into from
Sep 24, 2020
Merged

Fix website tests #590

merged 3 commits into from
Sep 24, 2020

Conversation

andyspiers
Copy link
Contributor

@andyspiers andyspiers commented Sep 18, 2020

Description

The test suite for terraform-provider-helm has been failing since the provider was migrated to the terraform registry in this commit hashicorp/terraform-website@da8a3fa (reason: removal of helm-related symlinks causes helm docs to be ignored by the terraform-website container and the test suite here to fail)

This is impeding new PRs being accepted on terraform-provider-helm because unit tests fail and hence acceptance tests don't run.

Implementation

This PR replaces the old website-test and website make targets with website-lint

website-lint is heavily based on hashicorp/terraform-provider-kubernetes#989 which solved this same problem for terraform-provider-kubernetes

Instead of spinning up a middleman-hashicorp container from https://github.com/hashicorp/terraform-website it uses other open-source, containerised tools to:

  • lint the website's markdown files
  • check for broken links

Finally, rather than running website-lint along with the unit tests and acceptance tests, it splits them out to a separate Github action which triggers when changes are made to the website path, thus saving a 5-10 min acceptance test suite run for changes which only affect the docs.

References

This is complementary to #566

It will hopefully help other PRs like #560 and #572 and make their tests start passing

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

@andyspiers andyspiers mentioned this pull request Sep 18, 2020
2 tasks
only triggers on changes to website/ path
no need to run >5min code tests for markdown changes
Copy link
Contributor

@sebglon sebglon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sebglon
Copy link
Contributor

sebglon commented Sep 24, 2020

@dak1n1 This can unlock all other PR CI.
Can you help us to improve this provider?

@aareet aareet merged commit 2972cd5 into hashicorp:master Sep 24, 2020
@ghost
Copy link

ghost commented Oct 25, 2020

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 hashibot-feedback@hashicorp.com. Thanks!

@ghost ghost locked as resolved and limited conversation to collaborators Oct 25, 2020
@andyspiers andyspiers deleted the fix-docs-tests branch October 25, 2020 10:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants