diff on project with submodules in Github actions

[nickyu42]

Hi all, I have been stuck on this issue where the submodule update command fails while running kibot in a Github action with the diff output. I have verified that git submodule update --init --recursive runs correctly and that the submodules are checked out. Initially I thought it was failing due to git@ url for the submodules but with a ssh-agent, the output still fails. Are there further ways I can debug this or skip the cache_git() function calling this command?

Error:

 - 'PCB diff between the last two changes' (basic_diff_pcb) [diff]
ERROR:Running ['/usr/bin/git', 'submodule', 'update', '--init', '--recursive'] returned 1 (kibot.gs - gs.py:902)

Steps:

    steps:
    - name: Checkout
      uses: actions/checkout@v4
      with:
        fetch-depth: '0'
        submodules: recursive
        ssh-key: ${{ secrets.SSH_KEY }}
        persist-credentials: false

    - uses: webfactory/[email protected]
      with:
        ssh-private-key: ${{ secrets.SSH_KEY }}

    - name: Add github.com to known_hosts
      run: |
        mkdir -p ~/.ssh
        ssh-keyscan github.com >> ~/.ssh/known_hosts

    # Debug
    - name: Test SSH access to GitHub
      run: ssh -T [email protected] || true
    
    # Debug
    - run: |
        git submodule status
        cat .gitmodules
        git config --list --show-origin
        /usr/bin/git submodule update --init --recursive

*.kibot.yaml

- name: basic_diff_pcb
  comment: PCB diff between the last two changes
  type: diff
  dir: diff
  layers:
  - layer: F.Cu
    suffix: F_Cu
    description: Front copper
  - layer: In1.Cu
    suffix: In1_Cu
    description: Inner layer 1
  - layer: In2.Cu
    suffix: In2_Cu
    description: Inner layer 2
  - layer: B.Cu
    suffix: B_Cu
    description: Bottom copper
  - layer: B.Paste
    suffix: B_Paste
    description: Bottom solder paste
  - layer: F.Paste
    suffix: F_Paste
    description: Front solder paste
  - layer: B.Silkscreen
    suffix: B_Silkscreen
    description: Bottom silkscreen (artwork)
  - layer: F.Silkscreen
    suffix: F_Silkscreen
    description: Front silkscreen (artwork)
  - layer: B.Mask
    suffix: B_Mask
    description: Bottom soldermask (negative)
  - layer: F.Mask
    suffix: F_Mask
    description: Front soldermask (negative)
  - layer: User.Drawings
    suffix: User_Drawings
    description: User drawings
  - layer: User.Comments
    suffix: User_Comments
    description: User comments
  - layer: Edge.Cuts
    suffix: Edge_Cuts
    description: Board shape
  - layer: B.Courtyard
    suffix: B_Courtyard
    description: Bottom courtyard area
  - layer: F.Courtyard
    suffix: F_Courtyard
    description: Front courtyard area
  - layer: B.Fab
    suffix: B_Fab
    description: Bottom documentation
  - layer: F.Fab
    suffix: F_Fab
    description: Front documentation
  options:
    old: KIBOT_LAST-1
    old_type: git
    cache_dir: ...
    add_link_id: true
    copy_instead_of_link: true

[set-soft]

Hi @nickyu42 ! I was on vacations.

I don't see how are you invoking KiBot. Anyways, you must add verbosity options to see why it fails.

About cache_git, you might try using git_diff_strategy: stash in the global options.