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

Update example code tests to run on PRs #13244

Open
sean1588 opened this issue Nov 5, 2024 · 0 comments
Open

Update example code tests to run on PRs #13244

sean1588 opened this issue Nov 5, 2024 · 0 comments
Labels
area/site Issues and feature enhancement requests for pulumi.com/docs. kind/engineering Work that is not visible to an external user kind/enhancement Improvements or new features

Comments

@sean1588
Copy link
Member

sean1588 commented Nov 5, 2024

There are a few alterations we should make to the testing of the example code under static/programs/ in order to make it easier to use. Right now people can run the test script locally to test their code if they really wanted to, but it assumes you have everything installed to run all the languages as well as the correct versions of the dependencies which most of us do not. This makes it difficult to use and configure locally for our contributors. Currently the tests are just a daily cron job that runs after the code has been merges as it only runs against master, so it would be better if we caught anything that causes the tests to fail at PR time. We should still continue to run them daily that way we can find out if any of them start to fail for other reasons outside of code compilation, so this behavior should be retained.

I want to get the tests running automatically in the pipeline when a PR is opened so that the contributor can get feedback right away if the code they updated doesn't work and that way they can view the error logs and can troubleshoot for themselves why the test failed without needing to worry about a lot of local configuration. It will also act as a guard rail to prevent it from being merged if the code doesn't pass.

The tests should only run if there is a diff to any files in the static/programs directory. It takes about a half hour to run so we don't want them running on all PRs - only the PRs that have changes to the example code.

@pulumi-bot pulumi-bot added the needs-triage Needs attention from the triage team label Nov 5, 2024
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Nov 5, 2024
@thoward thoward added area/site Issues and feature enhancement requests for pulumi.com/docs. kind/enhancement Improvements or new features kind/engineering Work that is not visible to an external user and removed needs-triage Needs attention from the triage team labels Nov 7, 2024
@thoward thoward moved this from 🤔 Triage to 🧳 Backlog in Docs 📚 Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/site Issues and feature enhancement requests for pulumi.com/docs. kind/engineering Work that is not visible to an external user kind/enhancement Improvements or new features
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

3 participants