chore: reorganise GA to check and build once and run tests with matrix strategy VSCODE-703 #1133
Conversation
Earlier snyk was never scanning the vscode project because of the combination of project auto-detection and the presence of .vscode-test folder which contains several directories with package.json files. This commit disables the auto-detection so that snyk run tests on the current project. Additionally the current project was having a problem with a package declaring optional dependencies. These optional dependencies were platform specific so for any platform, all the optional dependencies will never be installed, only the ones that are platform compatible. Snyk requires what is declared in package-lock.json to be also present in node_modules folder which is why it would've failed. In the same commit, we added a pre and post test hook to remove the identified problematic optional dependencies from package-lock file before running the test and then restore it when the test is finished.
Earlier we were running check, build and tests on each OS in our matrix which did not allow us to test whether a build on ubuntu would work fine on Windows / MacOS or not. With this commit we are re-organising to check and build once on ubuntu and use the final artifact later in the test job to run tests against. Accordingly the test-and-build-from-fork and draft-release workflows have been modified to adapt the same change.
himanshusinghs
force-pushed
the
chore/gh-actions-reorg-for-install-tests
branch
from
dedcaad to
de36329
Compare
himanshusinghs
left a comment
himanshusinghs
left a comment
There was a problem hiding this comment.
I am unable to approve (as author) but looks good to me 👍. I added a small question for clarification.
| status-check: | ||
| name: Test and Build | ||
| runs-on: ubuntu-latest | ||
| needs: [build-and-package, test] | ||
| if: always() | ||
| steps: | ||
| - name: Check job results | ||
| run: | | ||
| if [ "${{ needs.build-and-package.result }}" == "failure" ] || [ "${{ needs.test.result }}" == "failure" ]; then | ||
| echo "One or more jobs failed" | ||
| exit 1 | ||
| elif [ "${{ needs.build-and-package.result }}" == "cancelled" ] || [ "${{ needs.test.result }}" == "cancelled" ]; then | ||
| echo "One or more jobs were cancelled" | ||
| exit 1 | ||
| else | ||
| echo "All jobs completed successfully or were skipped" | ||
| exit 0 | ||
| fi |
There was a problem hiding this comment.
Curious about this, why was this needed?
There was a problem hiding this comment.
It was hanging without this. Perhaps there's a more elegant solution, but its not just AI slop. 😅
| name: Test and Build | ||
| runs-on: ubuntu-latest | ||
| needs: [build-and-package, test] | ||
| if: always() |
There was a problem hiding this comment.
it was hanging, when running a normal build, this would start but never resolve, so the checks never passed.
tculig
force-pushed
the
chore/gh-actions-reorg-for-install-tests
branch
from
ee225c0 to
15d18f7
Compare
| - name: Setup Node.js Environment | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 22.15.1 | ||
| cache: npm |
There was a problem hiding this comment.
let's move this inside ./.github/workflows/actions/run-tests
.github/workflows/draft-release.yaml
Outdated
| id: set-tag | ||
| run: echo "release-tag=${RELEASE_TAG}" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Upload updated package.json |
There was a problem hiding this comment.
I'm confused by this; what is this for? Why would a draft release upload a package.json?
Is it so the version number is different? Then package-lock.json is also interesting to us, arguably more
There was a problem hiding this comment.
The point is to build once and then use the built package for all subsequent tasks, namely running tests.
You are right about the package-lock file, I'll add it to the artifact..
There was a problem hiding this comment.
can we move build-and-package into this instead? this job doesn't do much on its own otherwise.
There was a problem hiding this comment.
also I don't see how this would do much; node_modules would also be what we're looking for if we're trying to skip the install step
| - name: Create Jira Tickets | ||
| if: > | ||
| ( | ||
| github.event_name == 'push' && github.ref == 'refs/heads/main' || | ||
| github.event_name == 'workflow_dispatch' || | ||
| github.event_name == 'schedule' | ||
| ) | ||
| shell: bash | ||
| env: | ||
| JIRA_API_TOKEN: ${{ inputs.JIRA_API_TOKEN }} | ||
| JIRA_BASE_URL: "https://jira.mongodb.org" | ||
| JIRA_PROJECT: "VSCODE" | ||
| JIRA_VULNERABILITY_BUILD_INFO: "- [GitHub Run|https://github.com/mongodb-js/vscode/actions/runs/${{github.run_id}}/jobs/${{github.job}}]" | ||
| run: | | ||
| pnpm run create-vulnerability-tickets > /dev/null |
There was a problem hiding this comment.
this is broken right now, I found out the hard way just now #1196
Description
Earlier we were running check, build and tests on each OS in our matrix which did not allow us to test whether a build on ubuntu would work fine on Windows / MacOS or not.
With this commit we are re-organising to check and build once on ubuntu and use the final artifact later in the test job to run tests against.
Accordingly the test-and-build-from-fork and draft-release workflows have been modified to adapt the same change.
This PR simply re-organise the existing actions and does not introduce any install tests just yet. That will come in a different PR.
Checklist
Motivation and Context
Open Questions
Dependents
Types of changes