Merge common parts of .taskcluster.yml (hashtag268)

[vikramsubramanian]

This will make the file more readable. )

[mayil-ai[bot]]

Possible Solution

• Define a YAML anchor for common settings in .taskcluster.yml:

  x-common-settings: &common_settings
  provisionerId: proj-bugbug
  workerType: batch
  created: { $fromNow: "" }
  deadline: { $fromNow: "1 hour" }
  payload:
    maxRunTime: 3600
  metadata:
    owner: mcastelluccio@mozilla.com
    source: ${repository}/raw/${head_rev}/.taskcluster.yml

• Update tasks to use the anchor:

  - taskId: { $eval: as_slugid("lint_task") }
  <<: *common_settings
  payload:
    <<: *common_settings.payload
    image: python:3.10
    command:
      - "/bin/bash"
      - "-lcx"
      - "git clone --quiet ${repository} &&
        cd bugbug &&
        git -c advice.detachedHead=false checkout ${head_rev} &&
        pip install --disable-pip-version-check --no-cache-dir --progress-bar off -r test-requirements.txt &&
        pre-commit run -a --show-diff-on-failure"
  metadata:
    <<: *common_settings.metadata
    name: bugbug lint
    description: bugbug lint

• Repeat the above step for each task, customizing the command, name, and description fields as necessary, and adding any task-specific settings that are not covered by the common anchor.

• Ensure that any unique settings for a task are not overwritten by the anchor. If necessary, use YAML's merge key feature (<<: *anchor_name) to combine the common settings with task-specific settings.

• Remove any redundant declarations of settings that are now covered by the anchor.

• Test the updated .taskcluster.yml to ensure that all tasks are still defined correctly and that the refactoring has not introduced any errors.

Code snippets to check

.taskcluster.yml

This snippet contains a large section of the .taskcluster.yml file, which is the focus of the issue. It shows the structure and tasks that may need to be refactored for better readability. https://github.com/Mayil-AI/bugbug-21dec23/blob/0acd00da46afbb37bd047c0bce06ce7cfad21568/.taskcluster.yml#L38-L412 This snippet also contains a section of the .taskcluster.yml file with conditional task definitions that could be part of the refactoring to improve readability. https://github.com/Mayil-AI/bugbug-21dec23/blob/0acd00da46afbb37bd047c0bce06ce7cfad21568/.taskcluster.yml#L271-L340 This snippet is part of the .taskcluster.yml file and includes task definitions that may be common with other parts and could be merged for better readability. https://github.com/Mayil-AI/bugbug-21dec23/blob/0acd00da46afbb37bd047c0bce06ce7cfad21568/.taskcluster.yml#L148-L412 This snippet from the .taskcluster.yml file includes conditional task definitions that could be refactored as part of the issue to merge common parts and improve readability. https://github.com/Mayil-AI/bugbug-21dec23/blob/0acd00da46afbb37bd047c0bce06ce7cfad21568/.taskcluster.yml#L213-L412 This snippet is from the .taskcluster.yml file and shows task definitions that may have commonalities with other tasks, which are relevant to the issue of merging common parts. https://github.com/Mayil-AI/bugbug-21dec23/blob/0acd00da46afbb37bd047c0bce06ce7cfad21568/.taskcluster.yml#L271-L412 This snippet from the .taskcluster.yml file includes task definitions that could be part of the refactoring process to merge common parts for better readability. https://github.com/Mayil-AI/bugbug-21dec23/blob/0acd00da46afbb37bd047c0bce06ce7cfad21568/.taskcluster.yml#L271-L412 This snippet is from the .taskcluster.yml file and contains task definitions that may be common with other parts and could be merged for better readability. https://github.com/Mayil-AI/bugbug-21dec23/blob/0acd00da46afbb37bd047c0bce06ce7cfad21568/.taskcluster.yml#L83-L412