How do I add a comment in GitHub action YML file?

Question

In the below syntax:

jobs:
  testing:
    name: some test
    runs-on: [ self-hosted, linux, xyz ]
    steps:
      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: 1.15.0
        id: go

      - name: Configure git client
        run: git config --global url."ssh://[email protected]:".insteadOf "https://github.com/"

---

How do I add run git client to fix some issue as a comment for the run command?

Answer 1

tl; dr

• Use : #

- run: git config --global url."ssh://[email protected]:".insteadOf "https://github.com/" # run git client to fix some issue
+ run: |
+   : # run git client to fix some issue
+   git config --global url."ssh://[email protected]:".insteadOf "https://github.com/"

ts; dr

I've been searching the official GitHub docs and googling around but couldn't find any working sample.

And I came up with the answer by using the : operand which just returns true followed by the comment # like so:

jobs:
  testing:
    name: some test
    runs-on: [ self-hosted, linux, xyz ]
    steps:
      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: 1.15.0
        id: go

      - name: Configure git client
        run: |
          : # run git client to fix some issue
          git config --global url."ssh://[email protected]:".insteadOf "https://github.com/"