|
| 1 | +# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md |
| 2 | +name: Sync Labels |
| 3 | + |
| 4 | +# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows |
| 5 | +on: |
| 6 | + push: |
| 7 | + paths: |
| 8 | + - ".github/workflows/sync-labels.ya?ml" |
| 9 | + - ".github/label-configuration-files/*.ya?ml" |
| 10 | + pull_request: |
| 11 | + paths: |
| 12 | + - ".github/workflows/sync-labels.ya?ml" |
| 13 | + - ".github/label-configuration-files/*.ya?ml" |
| 14 | + schedule: |
| 15 | + # Run daily at 8 AM UTC to sync with changes to shared label configurations. |
| 16 | + - cron: "0 8 * * *" |
| 17 | + workflow_dispatch: |
| 18 | + repository_dispatch: |
| 19 | + |
| 20 | +env: |
| 21 | + CONFIGURATIONS_FOLDER: .github/label-configuration-files |
| 22 | + CONFIGURATIONS_ARTIFACT: label-configuration-files |
| 23 | + |
| 24 | +jobs: |
| 25 | + check: |
| 26 | + runs-on: ubuntu-latest |
| 27 | + |
| 28 | + steps: |
| 29 | + - name: Checkout repository |
| 30 | + uses: actions/checkout@v4 |
| 31 | + |
| 32 | + - name: Download JSON schema for labels configuration file |
| 33 | + id: download-schema |
| 34 | + uses: carlosperate/download-file-action@v2 |
| 35 | + with: |
| 36 | + file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json |
| 37 | + location: ${{ runner.temp }}/label-configuration-schema |
| 38 | + |
| 39 | + - name: Install JSON schema validator |
| 40 | + run: | |
| 41 | + sudo npm install \ |
| 42 | + --global \ |
| 43 | + ajv-cli \ |
| 44 | + ajv-formats |
| 45 | +
|
| 46 | + - name: Validate local labels configuration |
| 47 | + run: | |
| 48 | + # See: https://github.com/ajv-validator/ajv-cli#readme |
| 49 | + ajv validate \ |
| 50 | + --all-errors \ |
| 51 | + -c ajv-formats \ |
| 52 | + -s "${{ steps.download-schema.outputs.file-path }}" \ |
| 53 | + -d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}" |
| 54 | +
|
| 55 | + download: |
| 56 | + needs: check |
| 57 | + runs-on: ubuntu-latest |
| 58 | + |
| 59 | + strategy: |
| 60 | + matrix: |
| 61 | + filename: |
| 62 | + # Filenames of the shared configurations to apply to the repository in addition to the local configuration. |
| 63 | + # https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels |
| 64 | + - universal.yml |
| 65 | + |
| 66 | + steps: |
| 67 | + - name: Download |
| 68 | + uses: carlosperate/download-file-action@v2 |
| 69 | + with: |
| 70 | + file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} |
| 71 | + |
| 72 | + - name: Pass configuration files to next job via workflow artifact |
| 73 | + uses: actions/upload-artifact@v4 |
| 74 | + with: |
| 75 | + path: | |
| 76 | + *.yaml |
| 77 | + *.yml |
| 78 | + if-no-files-found: error |
| 79 | + name: ${{ env.CONFIGURATIONS_ARTIFACT }} |
| 80 | + |
| 81 | + sync: |
| 82 | + needs: download |
| 83 | + runs-on: ubuntu-latest |
| 84 | + |
| 85 | + steps: |
| 86 | + - name: Set environment variables |
| 87 | + run: | |
| 88 | + # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable |
| 89 | + echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV" |
| 90 | +
|
| 91 | + - name: Determine whether to dry run |
| 92 | + id: dry-run |
| 93 | + if: > |
| 94 | + github.event_name == 'pull_request' || |
| 95 | + ( |
| 96 | + ( |
| 97 | + github.event_name == 'push' || |
| 98 | + github.event_name == 'workflow_dispatch' |
| 99 | + ) && |
| 100 | + github.ref != format('refs/heads/{0}', github.event.repository.default_branch) |
| 101 | + ) |
| 102 | + run: | |
| 103 | + # Use of this flag in the github-label-sync command will cause it to only check the validity of the |
| 104 | + # configuration. |
| 105 | + echo "::set-output name=flag::--dry-run" |
| 106 | +
|
| 107 | + - name: Checkout repository |
| 108 | + uses: actions/checkout@v4 |
| 109 | + |
| 110 | + - name: Download configuration files artifact |
| 111 | + uses: actions/download-artifact@v4 |
| 112 | + with: |
| 113 | + name: ${{ env.CONFIGURATIONS_ARTIFACT }} |
| 114 | + path: ${{ env.CONFIGURATIONS_FOLDER }} |
| 115 | + |
| 116 | + - name: Remove unneeded artifact |
| 117 | + uses: geekyeggo/delete-artifact@v4 |
| 118 | + with: |
| 119 | + name: ${{ env.CONFIGURATIONS_ARTIFACT }} |
| 120 | + |
| 121 | + - name: Merge label configuration files |
| 122 | + run: | |
| 123 | + # Merge all configuration files |
| 124 | + shopt -s extglob |
| 125 | + cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}" |
| 126 | +
|
| 127 | + - name: Install github-label-sync |
| 128 | + run: sudo npm install --global github-label-sync |
| 129 | + |
| 130 | + - name: Sync labels |
| 131 | + env: |
| 132 | + GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 133 | + run: | |
| 134 | + # See: https://github.com/Financial-Times/github-label-sync |
| 135 | + github-label-sync \ |
| 136 | + --labels "${{ env.MERGED_CONFIGURATION_PATH }}" \ |
| 137 | + ${{ steps.dry-run.outputs.flag }} \ |
| 138 | + ${{ github.repository }} |
0 commit comments