https://github.com/rematocorp/submodule-status-commenter

GitHub action to automatically comment git submodule status to the PR
https://github.com/rematocorp/submodule-status-commenter

code-review git github-actions pull-request submodule

Last synced: 5 months ago
JSON representation

GitHub action to automatically comment git submodule status to the PR

• Host: GitHub
• URL: https://github.com/rematocorp/submodule-status-commenter
• Owner: rematocorp
• License: mit
• Created: 2024-02-01T11:46:26.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-08-27T06:58:42.000Z (6 months ago)
• Last Synced: 2025-08-27T15:50:09.889Z (6 months ago)
• Topics: code-review, git, github-actions, pull-request, submodule
• Language: TypeScript
• Homepage:
• Size: 1.28 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Git Submodule Status Commenter

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

> **Submodule "foo" status**

>

> -   **[Current branch](#)**: feature/bar

> -   **Behind main**: 2 (4 days)

> -   **Ahead main**: 1

> -   **[Pull request](#)**: Introduce new buttons

> -   **[Last commit](#)**: _"Merge pull request foo#182" by John Doe_

## Configuration

```yaml

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 }}

```