docs: DOC-205: Document changes to ML backend #6936
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
| name: "Dependencies check" | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| - 'ls-release/**' | |
| pull_request: | |
| types: | |
| - opened | |
| - synchronize | |
| - reopened | |
| - ready_for_review | |
| branches: | |
| - develop | |
| - 'ls-release/**' | |
| env: | |
| ACTIONS_STEP_DEBUG: '${{ secrets.ACTIONS_STEP_DEBUG }}' | |
| jobs: | |
| validate_submodules_and_dependencies: | |
| name: "Submodules/deps" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: hmarr/[email protected] | |
| - name: Validate | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| const {repo, owner} = context.repo; | |
| const head_sha = '${{ github.event.pull_request.head.sha || github.event.after }}' | |
| const base_sha = '${{ github.event.pull_request.base.sha || github.event.before }}' | |
| const targetBranch = '${{ github.event.pull_request.base.ref || github.event.ref }}'.replace('refs/heads/', '') | |
| const strictCheckBranchPrefixes = ['ls-release/']; | |
| const submodules = [ | |
| { | |
| owner: owner, | |
| repo: 'label-studio-frontend', | |
| file_path: 'label_studio/frontend/dist/lsf/version.json', | |
| regexp: /"commit": "(?<sha>[a-f0-9]{40})",/, | |
| }, | |
| { | |
| owner: owner, | |
| repo: 'dm2', | |
| file_path: 'label_studio/frontend/dist/dm/version.json', | |
| regexp: /"commit": "(?<sha>[a-f0-9]{40})",/, | |
| }, | |
| { | |
| owner: owner, | |
| repo: 'label-studio-sdk', | |
| file_path: 'pyproject.toml', | |
| regexp: /label-studio-sdk(\/archive|.git).*(?<sha>[a-f0-9]{40})/, | |
| }, | |
| ]; | |
| async function getSubmoduleVersion(submodule, sha) { | |
| const response = await github.rest.repos.getContent({ | |
| owner: owner, | |
| repo: repo, | |
| ref: sha, | |
| path: submodule.file_path, | |
| }); | |
| const content = Buffer.from(response.data.content, response.data.encoding).toString('utf-8'); | |
| const match = content.match(submodule.regexp); | |
| return match.groups.sha; | |
| } | |
| async function validateSubmodule(submodule, base_sha, head_sha) { | |
| const before = await getSubmoduleVersion(submodule, base_sha); | |
| const after = await getSubmoduleVersion(submodule, head_sha); | |
| if (before === after && !strictCheck) { | |
| return [true, 'Not changed'] | |
| } | |
| const {data: compare} = await github.rest.repos.compareCommits({ | |
| owner: submodule.owner, | |
| repo: submodule.repo, | |
| base: before, | |
| head: after, | |
| }); | |
| const {data: submoduleRepo} = await github.rest.repos.get({ | |
| owner: submodule.owner, | |
| repo: submodule.repo, | |
| }); | |
| const submoduleBranch = targetBranch === 'develop' ? submoduleRepo.default_branch : targetBranch | |
| const {data: listCommits} = await github.rest.repos.listCommits({ | |
| owner: submodule.owner, | |
| repo: submodule.repo, | |
| per_page: 100, | |
| sha: submoduleBranch, | |
| }); | |
| const commits = listCommits.map(e => e.sha) | |
| const headCommitNumber = commits.indexOf(after) | |
| if (headCommitNumber === -1) { | |
| return [false, `${after} from PR is not found in submodule ${submoduleBranch} branch`] | |
| } | |
| if (strictCheck && headCommitNumber !== 0) { | |
| return [false, `For the release branch, submodule should be pointed to the latest commit in submodule's corresponding release branch which is ${listCommits[0].html_url}`] | |
| } | |
| const baseCommitNumber = commits.indexOf(before) | |
| if (baseCommitNumber === -1) { | |
| return [true, `${submodule.repo}: ${before} from ${targetBranch} is not found in submodule ${submoduleBranch} branch`] | |
| } | |
| return [compare.behind_by === 0, `${after} is ${compare.ahead_by} ahead and ${compare.behind_by} behind ${before}: ${compare.html_url}`] | |
| } | |
| const strictCheck = strictCheckBranchPrefixes.some(e => targetBranch.startsWith(e)) | |
| console.log(`Strict check is ${strictCheck? 'on': 'off'}`) | |
| let base_sha_redacted = base_sha | |
| if (base_sha === '0000000000000000000000000000000000000000') { | |
| const {data: commit} = await github.rest.git.getCommit({ | |
| owner, | |
| repo, | |
| commit_sha: head_sha, | |
| }); | |
| base_sha_redacted = commit.parents[0].sha | |
| console.log(`Branch creation event. Using head_sha (${base_sha_redacted}) parent as base_sha`) | |
| } | |
| const {data: lsCompare} = await github.rest.repos.compareCommits({ | |
| owner: owner, | |
| repo: repo, | |
| base: base_sha_redacted, | |
| head: head_sha, | |
| }); | |
| for (let submodule of submodules) { | |
| let status = {} | |
| if (lsCompare.files.some(e => e.filename === submodule.file_path)) { | |
| status = await validateSubmodule(submodule, base_sha, head_sha); | |
| } else { | |
| status = [true, `Not changed`] | |
| } | |
| if (status[0] === false) { | |
| core.setFailed(`${submodule.owner}/${submodule.repo}: ${status[1]}`) | |
| } else { | |
| core.info(`${submodule.owner}/${submodule.repo}: ${status[1]}`) | |
| } | |
| } |