Taskfile.yml

version : '3'

set: [pipefail]

vars:
  SPECFILE:
    sh: if [ -f "{{ .USER_WORKING_DIR }}/package.yml" ]; then echo "package.yml"; else echo "pspec.xml"; fi;
  PSPECFILE:
    sh: if [ -f "{{ .USER_WORKING_DIR }}/package.yml" ]; then echo "pspec_x86_64.xml"; else echo "pspec.xml"; fi;

includes:
  qt5:
    taskfile: ./common/Tasks/Taskfile.qt5.yml
  infra:
    dir: ../infrastructure-tooling
    taskfile: ../infrastructure-tooling/Infra.yml
    optional: true

tasks:
  # Ensure people new to go-task and used to 'make help' have an easier time
  help:
    desc: Show how to list available tasks
    cmds:
      - |
        echo "Use 'go-task -l/--list' to list available tasks."

  # Utility tasks, mainly for precondition checks
  package-file:
    internal: true
    desc: |
      Check that either `package.yml` or `pspec.xml` exists in the current directory
    dir: '{{ .USER_WORKING_DIR }}'
    requires:
      vars: [SPECFILE]
    preconditions:
      - sh: test -f package.yml || test -f pspec.xml
        msg: Either `package.yml` or `pspec.xml` must exists in the current directory

  solbuild-reset:
    desc: |
      Delete all existing solbuild cache and images, then download fresh solbuild images + cache updates
    cmds: 
      - sudo solbuild delete-cache --all --images
      - sudo solbuild init --update --profile unstable-x86_64
      - sudo solbuild init --update --profile main-x86_64

  # Build packages
  build:
    desc: Build the current package against the unstable repo
    aliases: [default]
    dir: '{{ .USER_WORKING_DIR }}'
    vars:
      PROFILE: '{{ default "unstable-x86_64" .PROFILE }}'
    deps:
      - package-file
    cmds:
      - |
        sudo solbuild build {{ .SPECFILE }} -p {{ .PROFILE }} {{ .CLI_ARGS }}

  build-local:
    desc: "Build the current package against the unstable and the default local repo"
    aliases: [local]
    cmds:
      # Ensure that we're always building against a fresh local repo index
      - task: build-localindex
      - task: build
        vars:
          PROFILE: 'local-unstable-x86_64'

  build-localcp:
    desc: "Build the current package against the unstable and the default local repo and forcibly copy .eopkgs to the default local repo."
    aliases: [localcp]
    cmds:
      - task: build-local
      - |
        sudo cp -fv {{ .USER_WORKING_DIR }}/*.eopkg /var/lib/solbuild/local/
      # Ensure that the freshly built package is picked up by the local repo index
      - task: build-localindex

  build-localindex:
    desc: "Rebuild the local repo index if it exists."
    aliases: [localindex]
    cmds:
      - |
        [[ -d /var/lib/solbuild/local ]] && \
        sudo eopkg index --skip-signing /var/lib/solbuild/local/ --output /var/lib/solbuild/local/eopkg-index.xml && \
        sudo eopkg ur  # Force eopkg to pick up the new index

  build-stable:
    desc: Build the current package against the stable repo (do NOT use for official submissions!)
    aliases: [stable]
    cmds:
      - task: build
        vars:
          PROFILE: 'main-x86_64'
      - |
        echo "=========================================================================="
        echo "WARNING: This package was built against -stable and is for local use only."
        echo "                                                                          "
        echo "         Do NOT publish packages or Pull Requests built against -stable!!!"
        echo "=========================================================================="

  # Modify package recipes
  bump:
    desc: Bump current release
    dir: '{{ .USER_WORKING_DIR }}'
    vars:
      YBUMP: "ybump"
      PBUMP: "{{ .TASKFILE_DIR }}/common/Scripts/pbump.py"
      BUMP_SCRIPT: '{{ eq .SPECFILE "package.yml" | ternary .YBUMP .PBUMP }}'
    deps:
      - package-file
    cmds:
      - |
        {{ .BUMP_SCRIPT }} {{ .SPECFILE }}

  convert:
    desc: Convert pspec to package.yml
    dir: '{{ .USER_WORKING_DIR }}'
    preconditions:
      - sh: test -f pspec.xml
        msg: "`pspec.xml` must exist in the current directory to perform conversion"
    cmds:
      - |
        {{ .TASKFILE_DIR }}/common/Scripts/yconvert.py pspec.xml

  cvecheck:
    desc: Check package for CVEs
    dir: '{{ .USER_WORKING_DIR }}'
    cmds:
      - cve-check-tool {{ .PSPECFILE }} -M {{ .TASKFILE_DIR }}/common/mapping -o report.html

  notify-complete:
    desc: Get a notification when the build has finished on the buildserver
    dir: '{{ .USER_WORKING_DIR }}'
    deps:
      - package-file
    cmds:
      - "{{ .TASKFILE_DIR }}/common/Scripts/buildserver-notification.sh"

  pkgconfig:
    desc: |
      Find which package provides a given pkgconfig target.

      Example usage: `go-task pkgconfig -- Qt5Core Qt6Core`
    cmds:
      - |
        {{ .TASKFILE_DIR }}/common/Scripts/epcsearch.py {{ .CLI_ARGS }}

  update:
    desc: |
      Update an existing package.yml recipe to a new version given a version and a download URI.

      Example usage: `go-task update -- 7.2 https://www.nano-editor.org/dist/v7/nano-7.2.tar.xz`
    dir: '{{ .USER_WORKING_DIR }}'
    preconditions:
      - sh: test -f package.yml
        msg: "`package.yml` must exist in the current directory"
    cmds:
      - |
        yupdate {{ .CLI_ARGS }}

  # For staff and packagers with push access
  publish:
    desc: >-
      Publish the last commit for the current package to the repository and the build server.
      The `run-safety-catches` task is used to check for common issues before pushing.
    dir: '{{ .USER_WORKING_DIR }}'
    preconditions:
      - sh: test $(git symbolic-ref HEAD 2>/dev/null) = "refs/heads/main"
        msg: Not on main branch
    deps:
      - package-file
    cmds:
      - task: run-safety-catches
      - git push
      - task: push

  republish:
    desc: >-
      Retry the last commit for the current package on the build server.
      The `run-safety-catches` task is used to check for common issues before pushing.
    dir: '{{ .USER_WORKING_DIR }}'
    preconditions:
      - sh: test $(git symbolic-ref HEAD 2>/dev/null) = "refs/heads/main"
        msg: Not on main branch
    cmds:
      - task: run-safety-catches
      - task: push

  run-safety-catches:
    desc: Check for issues in the currently staged commits using the CI package checks.
    dir: '{{ .USER_WORKING_DIR }}'
    cmds:
      - "{{ .TASKFILE_DIR }}/common/Scripts/package-publish-safety-catches.sh"

  push:
    desc: Push package to the build server
    internal: true
    dir: '{{ .USER_WORKING_DIR }}'
    vars:
      SOURCE:
        sh: basename '{{ .USER_WORKING_DIR }}'
      TAG:
        sh: if [ -f {{ .SPECFILE }} ]; then {{ .TASKFILE_DIR }}/common/Scripts/gettag.py {{ .USER_WORKING_DIR }}/{{ .SPECFILE }}; fi
      PATH:
        sh: git rev-parse --show-prefix
      REF:
        sh: git rev-list -1 HEAD "{{ .USER_WORKING_DIR }}"
      PUBLISH_COMMENT: '{{ .PUBLISH_COMMENT | default "" | b64enc }}'
    cmds:
      - ssh build-controller@build.getsol.us build "{{ .SOURCE }}" "{{ .TAG }}" "{{ .PATH }}" "{{ .REF }}" "{{ .PUBLISH_COMMENT }}"

  # Other utilities
  check:
    desc: Run package sanity checks
    dir: '{{ .USER_WORKING_DIR }}'
    cmds:
      - "{{ .TASKFILE_DIR }}/common/CI/package_checks.py --modified --untracked --base origin/main {{.CLI_ARGS}}"

  clean:
    desc: Clean .eopkgs found in the current directory
    dir: '{{ .USER_WORKING_DIR }}'
    cmds:
      - rm *.eopkg -fv

  clean-all:
    desc: List all .eopkgs found in the monorepo, ask before deleting them.
    cmds:
      - task: list-all-eopkgs   # first show all found .eopkg files
      - task: delete-all-eopkgs # then prompt before deleting them

  delete-all-eopkgs:
    desc: Ask before deleting all .eopkgs found in the monorepo.
    dir: '{{ .TASKFILE_DIR }}'
    prompt: This will delete ALL .eopkgs found in the monorepo. Do you wish to continue?
    cmds:
      - find $(git rev-parse --show-toplevel) -type f -name '*.eopkg' -delete

  list-all-eopkgs:
    desc: List all .eopkgs found in the monorepo
    dir: '{{ .TASKFILE_DIR }}'
    cmds:
      - find $(git rev-parse --show-toplevel) -type f -name '*.eopkg' -print

  init:
    desc: Initialize the packages repo
    cmds:
      - ln -sf ../../common/Hooks/pre-commit.py $(git rev-parse --git-path hooks)/pre-commit
      - ln -sf ../../common/Hooks/prepare-commit-msg.py $(git rev-parse --git-path hooks)/prepare-commit-msg
      - ln -sf ../../common/Hooks/post-merge.sh $(git rev-parse --git-path hooks)/post-merge
      - ln -sf ../../common/Hooks/post-rewrite.sh $(git rev-parse --git-path hooks)/post-rewrite

  pull:
    desc: Pull/rebase latest changes
    dir: '{{ .USER_WORKING_DIR }}'
    preconditions:
      - git rev-parse --is-inside-work-tree
    cmds:
      - git pull --rebase

  new:
    desc: Create a new package
    dir: '{{ .USER_WORKING_DIR }}'
    vars:
      NEWPKG: "{{ .TASKFILE_DIR }}/common/Scripts/new-package.sh"
    cmds:
      - |
        {{ .NEWPKG }} {{.CLI_ARGS}}

  add-monitoring:
    desc: Add skeleton for monitoring.yml
    dir: '{{ .USER_WORKING_DIR }}'
    vars:
      DATE:
        sh: date -u +%Y-%m-%d
      COMMENT: "# No known CPE, checked {{ .DATE }}"
    cmds:
      - touch monitoring.yml
      - yq --inplace '
          .releases.id line_comment = "# Check https://release-monitoring.org/" |
          .releases.rss line_comment = "# For example https://github.com/PyO3/maturin/releases.atom" |
          (.security | key) head_comment = "{{ .COMMENT }}" |
          .security.cpe = ~
        '  monitoring.yml