Skip to content
rematocorp

GitHub Action

Git Submodule Status Commenter

v2.2.0 Latest version

Git Submodule Status Commenter

rematocorp

Git Submodule Status Commenter

GitHub action to comment git submodule status to the PR

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Git Submodule Status Commenter

uses: rematocorp/[email protected]

Learn more about this action in rematocorp/submodule-status-commenter

Choose a version

Git Submodule Status Commenter

This action informs reviewers about the submodule status in the PR:

Submodule "foo" status

Configuration

name: Submodule status commenter
on:
    pull_request:
        types: [opened, synchronize, reopened, ready_for_review]
jobs:
    run:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
              with:
                  token: ${{ secrets.GITHUB_TOKEN }}
                  submodules: true

            - uses: rematocorp/submodule-status-commenter@v2
              with:
                  github-token: ${{ secrets.GITHUB_TOKEN }}