feat: self update if there have been changes to the grammar but it was not built locally #103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Here's a PR testing this: #104 (support issue created for CLA bot approval thing: https://github.com/hashicorp/releng-support/issues/248) |
dbanck
reviewed
Feb 22, 2024
94e408f to
860a2a3
Compare
dbanck
reviewed
Feb 26, 2024
…s not built locally This PR adds a new workflow to run on pull requests only while adjusting the existing test workflow to only run on commits on main from now on. The following will happen on PRs now: * `npm run build` will be run as part of a new build job * `copywrite headers` will be run as part of the build job as well * If there are any changes (e.g. to file headers) or to the generated syntax json files the diff will be committed as a new commit and the workflow is aborted * If there are no changes (e.g. when running on the self-update commit after it has been made) the test job will run and decide the fate of whether the workflow fails or succeeds This pattern is something we used over in CDKTF repositories a lot. It stems from the projen.io configuration management tool. This change allows us to forget to run build and still get correct test results. Currently, if you forget to run build locally, the tests might still pass as they run against the now stale generated json grammar files.
This will be handled in a separate workflow, refer to #105 for more
860a2a3 to
121c618
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new workflow to run on pull requests only while adjusting the existing test workflow to only run on commits on main from now on.
The following will happen on PRs now:
npm run buildwill be run as part of a new build jobcopywrite headerswill be run as part of the build job as wellThis pattern is something we used over in CDKTF repositories a lot. It stems from the projen.io configuration management tool.
This change allows us to forget to run build and still get correct test results. Currently, if you forget to run build locally, the tests might still pass as they run against the now stale generated json grammar files.
Todos
tokenon the checkout action in the job that does the patch commit. Without this Github actions won't re-run on the self-update commit.