diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 699670c1071..d59e2171c4a 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -812,7 +812,7 @@ embed.go @grafana/grafana-as-code /.github/workflows/i18n-crowdin-upload.yml @grafana/grafana-frontend-platform /.github/workflows/i18n-crowdin-download.yml @grafana/grafana-frontend-platform /.github/workflows/i18n-crowdin-create-tasks.yml @grafana/grafana-frontend-platform -/.github/workflows/scripts/crowdin/create-tasks.js @grafana/grafana-frontend-platform +/.github/workflows/scripts/crowdin/create-tasks.ts @grafana/grafana-frontend-platform /.github/workflows/pr-go-workspace-check.yml @grafana/grafana-app-platform-squad /.github/workflows/pr-dependabot-update-go-workspace.yml @grafana/grafana-app-platform-squad /.github/workflows/pr-k8s-codegen-check.yml @grafana/grafana-app-platform-squad diff --git a/.github/workflows/i18n-crowdin-create-tasks.yml b/.github/workflows/i18n-crowdin-create-tasks.yml index be4a5c3c270..f17552ea362 100644 --- a/.github/workflows/i18n-crowdin-create-tasks.yml +++ b/.github/workflows/i18n-crowdin-create-tasks.yml @@ -2,8 +2,10 @@ name: Crowdin Create Tasks on: workflow_dispatch: + # TODO uncomment when we're confident this works + # once a week on Sunday at midnight # schedule: - # - cron: "0 0 * * *" + # - cron: "0 0 * * 0" jobs: create-tasks-in-crowdin: @@ -33,8 +35,10 @@ jobs: with: node-version-file: '.nvmrc' + - run: yarn install --immutable --check-cache + - name: Create tasks env: CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }} CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }} - run: node ./.github/workflows/scripts/crowdin/create-tasks.js + run: node --experimental-strip-types ./.github/workflows/scripts/crowdin/create-tasks.ts diff --git a/.github/workflows/scripts/crowdin/create-tasks.js b/.github/workflows/scripts/crowdin/create-tasks.js deleted file mode 100644 index d3085f8afa0..00000000000 --- a/.github/workflows/scripts/crowdin/create-tasks.js +++ /dev/null @@ -1,84 +0,0 @@ -const crowdin = require('@crowdin/crowdin-api-client'); -const TRANSLATED_CONNECTOR_DESCRIPTION = '{{tos_service_type: premium}}'; - -const API_TOKEN = process.env.CROWDIN_PERSONAL_TOKEN; -if (!API_TOKEN) { - console.error('Error: CROWDIN_PERSONAL_TOKEN environment variable is not set'); - process.exit(1); -} - -const PROJECT_ID = process.env.CROWDIN_PROJECT_ID; -if (!PROJECT_ID) { - console.error('Error: CROWDIN_PROJECT_ID environment variable is not set'); - process.exit(1); -} - -const { tasksApi, projectsGroupsApi, sourceFilesApi } = new crowdin.default({ - token: API_TOKEN, - organization: 'grafana' -}); - -const languages = await getLanguages(); -const fileIds = await getFileIds(); -console.log('Languages: ', languages); -console.log('File IDs: ', fileIds); - -// for (const language of languages) { -// const { name, id } = language; -// await createTask(`Translate to ${name}`, id, fileIds); -// } - -async function getLanguages() { - try { - const project = await projectsGroupsApi.getProject(PROJECT_ID); - const languages = project.data.targetLanguages; - return languages; - } catch (error) { - console.error('Failed to fetch languages: ', error.message); - if (error.response && error.response.data) { - console.error('Error details: ', JSON.stringify(error.response.data, null, 2)); - } - process.exit(1); - } -} - -async function getFileIds() { - try { - const response = await sourceFilesApi.listProjectFiles(PROJECT_ID); - const files = response.data; - const fileIds = files.map(file => file.data.id); - return fileIds; - } catch (error) { - console.error('Failed to fetch file IDs: ', error.message); - if (error.response && error.response.data) { - console.error('Error details: ', JSON.stringify(error.response.data, null, 2)); - } - process.exit(1); - } -} - -async function createTask(title, languageId, fileIds) { - try { - const taskParams = { - title, - description: TRANSLATED_CONNECTOR_DESCRIPTION, - languageId, - type: 2, // Translation by vendor - workflowStepId: 78, // Translation step ID - skipAssignedStrings: true, - fileIds, - }; - - console.log(`Creating Crowdin task: "${title}" for language ${languageId}`); - - const response = await tasksApi.addTask(PROJECT_ID, taskParams); - console.log(`Task created successfully! Task ID: ${response.data.id}`); - return response.data; - } catch (error) { - console.error('Failed to create Crowdin task: ', error.message); - if (error.response && error.response.data) { - console.error('Error details: ', JSON.stringify(error.response.data, null, 2)); - } - process.exit(1); - } -} diff --git a/.github/workflows/scripts/crowdin/create-tasks.ts b/.github/workflows/scripts/crowdin/create-tasks.ts new file mode 100644 index 00000000000..b4f76e699bd --- /dev/null +++ b/.github/workflows/scripts/crowdin/create-tasks.ts @@ -0,0 +1,110 @@ +import crowdinImport from '@crowdin/crowdin-api-client'; +const TRANSLATED_CONNECTOR_DESCRIPTION = '{{tos_service_type: premium}}'; +const TRANSLATE_BY_VENDOR_WORKFLOW_TYPE = 'TranslateByVendor' + +// TODO Remove this type assertion when https://github.com/crowdin/crowdin-api-client-js/issues/508 is fixed +// @ts-expect-error +const crowdin = crowdinImport.default as typeof crowdinImport; + +const API_TOKEN = process.env.CROWDIN_PERSONAL_TOKEN; +if (!API_TOKEN) { + console.error('Error: CROWDIN_PERSONAL_TOKEN environment variable is not set'); + process.exit(1); +} + +const PROJECT_ID = process.env.CROWDIN_PROJECT_ID ? parseInt(process.env.CROWDIN_PROJECT_ID, 10) : undefined; +if (!PROJECT_ID) { + console.error('Error: CROWDIN_PROJECT_ID environment variable is not set'); + process.exit(1); +} + +const credentials = { + token: API_TOKEN, + organization: 'grafana' +}; + +const { tasksApi, projectsGroupsApi, sourceFilesApi, workflowsApi } = new crowdin(credentials); + +const languages = await getLanguages(PROJECT_ID); +const fileIds = await getFileIds(PROJECT_ID); +const workflowStepId = await getWorkflowStepId(PROJECT_ID); + +for (const language of languages) { + const { name, id } = language; + await createTask(PROJECT_ID, `Translate to ${name}`, id, fileIds, workflowStepId); +} + +async function getLanguages(projectId) { + try { + const project = await projectsGroupsApi.getProject(projectId); + const languages = project.data.targetLanguages; + console.log('Fetched languages successfully!'); + return languages; + } catch (error) { + console.error('Failed to fetch languages: ', error.message); + if (error.response && error.response.data) { + console.error('Error details: ', JSON.stringify(error.response.data, null, 2)); + } + process.exit(1); + } +} + +async function getFileIds(projectId) { + try { + const response = await sourceFilesApi.listProjectFiles(projectId); + const files = response.data; + const fileIds = files.map(file => file.data.id); + console.log('Fetched file ids successfully!'); + return fileIds; + } catch (error) { + console.error('Failed to fetch file IDs: ', error.message); + if (error.response && error.response.data) { + console.error('Error details: ', JSON.stringify(error.response.data, null, 2)); + } + process.exit(1); + } +} + +async function getWorkflowStepId(projectId) { + try { + const response = await workflowsApi.listWorkflowSteps(projectId); + const workflowSteps = response.data; + const workflowStepId = workflowSteps.find(step => step.data.type === TRANSLATE_BY_VENDOR_WORKFLOW_TYPE)?.data.id; + if (!workflowStepId) { + throw new Error(`Workflow step with type "${TRANSLATE_BY_VENDOR_WORKFLOW_TYPE}" not found`); + } + console.log('Fetched workflow step ID successfully!'); + return workflowStepId; + } catch (error) { + console.error('Failed to fetch workflow step ID: ', error.message); + if (error.response && error.response.data) { + console.error('Error details: ', JSON.stringify(error.response.data, null, 2)); + } + process.exit(1); + } +} + +async function createTask(projectId, title, languageId, fileIds, workflowStepId) { + try { + const taskParams = { + title, + description: TRANSLATED_CONNECTOR_DESCRIPTION, + languageId, + workflowStepId, + skipAssignedStrings: true, + fileIds, + }; + + console.log(`Creating Crowdin task: "${title}" for language ${languageId}`); + + const response = await tasksApi.addTask(projectId, taskParams); + console.log(`Task created successfully! Task ID: ${response.data.id}`); + return response.data; + } catch (error) { + console.error('Failed to create Crowdin task: ', error.message); + if (error.response && error.response.data) { + console.error('Error details: ', JSON.stringify(error.response.data, null, 2)); + } + process.exit(1); + } +}