chore: Add worklow to check cyclic deps in a PR #33197
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| name: Cyclic Dependency Check | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| pr: | ||
| description: "This is the PR number in case the workflow is being called in a pull request" | ||
| required: false | ||
| type: number | ||
|
|
||
| jobs: | ||
| check-cyclic-dependencies: | ||
| runs-on: ubuntu-latest | ||
| defaults: | ||
| run: | ||
| working-directory: app/client | ||
| shell: bash | ||
|
|
||
| steps: | ||
| # The checkout steps MUST happen first because the default directory is set according to the code base. | ||
| # GitHub Action expects all future commands to be executed in the code directory. Hence, we need to check out | ||
| # the code before doing anything else. | ||
|
|
||
| # Check out merge commit with the base branch in case this workflow is invoked via pull request | ||
| - name: Checkout the merged commit from PR and base branch | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: refs/pull/${{ inputs.pr }}/merge | ||
|
|
||
| - name: Count circular dependencies on PR branch | ||
| id: count-cyclic-deps-in-pr | ||
| run: | | ||
| npx dpdm ./src/* --circular --warning=false --tree=false > pr_circular_deps.txt | ||
| pr_count=$(cat pr_circular_deps.txt | wc -l) | ||
| echo "pr_count=$pr_count" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Checkout release branch | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| ref: release | ||
|
|
||
| - name: Check release log | ||
| run: | | ||
| git log -1 | ||
|
|
||
| - name: Count circular dependencies on release branch | ||
| id: coun-cyclic-deps-in-release | ||
| run: | | ||
| npx dpdm ./src/* --circular --warning=false --tree=false > release_circular_deps.txt | ||
| release_count=$(cat release_circular_deps.txt | wc -l) | ||
| echo "release_count=$release_count" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Compare circular dependencies | ||
| id: compare-deps | ||
| run: | | ||
| release_count=${{ steps.coun-cyclic-deps-in-release.outputs.release_count }} | ||
| pr_count=${{ steps.count-cyclic-deps-in-pr.outputs.pr_count }} | ||
| diff=$((pr_count - release_count)) | ||
|
|
||
| if [ "$diff" -gt 0 ]; then | ||
| echo "has_more_cyclic_deps=true" >> "$GITHUB_OUTPUT" | ||
| echo "diff=$diff" >> "$GITHUB_OUTPUT" | ||
| fi | ||
|
|
||
| # Comment on the PR if cyclic dependencies are found | ||
| - name: Comment the result on PR | ||
| if: steps.compare-deps.outputs.has_more_cyclic_deps == 'true' | ||
| uses: actions/github-script@v3 | ||
| with: | ||
| github-token: ${{secrets.GITHUB_TOKEN}} | ||
| script: | | ||
| const prNumber = context.payload.pull_request.number; | ||
| const message = `⚠️ Cyclic Dependency Check:\n\nThis PR has increased the number of cyclic dependencies by ${{steps.compare-deps.outputs.diff}}, when compared with the release branch.\n\nRefer [this document](https://appsmith.notion.site/How-to-check-cyclic-dependencies-c47b08fe5f2f4261a3a234b19e13f2db) to identify the cyclic dependencies introduced by this PR.`; | ||
| github.issues.createComment({ | ||
| ...context.repo, | ||
| issue_number: prNumber, | ||
| body: message | ||
| }); | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| const { parseDependencyTree, parseCircular, prettyCircular } = require("dpdm"); | ||
|
|
||
| const CIRCULAR_DEPS_IN_RELEASE = 2965; | ||
|
Collaborator
There was a problem hiding this comment. I think having a constant will not be very convenient for us in the future. Especially when we start working on reducing the number of dependencies and we have to edit it manually every time. I think we could checkout to the
Author
|
||
|
|
||
| parseDependencyTree("./src", {}).then((tree) => { | ||
| const circulars = parseCircular(tree); | ||
| if (circulars.length > CIRCULAR_DEPS_IN_RELEASE) { | ||
| console.log("Failed!"); | ||
| } | ||
| console.log(prettyCircular(circulars)); | ||
| }); | ||
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.