Include action url in commit message

[hadley]

It would be super useful to include the url to the summary page of the current action in the commit message so you could more easily jump to the log.

[stefanzweifel]

Sorry only saw this discussion today.

You're suggesting that the commit message created by git-auto-commit automatically adds a link to the "run"-page where the commit has been created from, to the commit body, right?

So instead of a commit log that would look like this:

commit 4593f3c90f7d97682e4e615849d48a8991ffabc859579e8a3921f1647f5ad340
Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date:   2024-07-06 12:06:47 +0200

    Apply automatic changes

It would look like this:

commit 4593f3c90f7d97682e4e615849d48a8991ffabc859579e8a3921f1647f5ad340
Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date:   2024-07-06 12:06:47 +0200

    Apply automatic changes

    https://github.com/stefanzweifel/git-auto-commit-action/actions/runs/9818457191

I think this is not something I would like to add to the action itself. I currently can't see the benefit of adding this to all commits made with this action.

However, you're able to do this yourself by reading the GITHUB_RUN_ID-variable and using it in a multiline commit mesage.

I haven't tested this exact workflow, but this is how you could add a link to the workflow run to the body of your commit.

    # Building a multiline commit message
    # Adjust to your liking
    - run: echo "Apply automatic changes" >> commitmessage.txt
    - run: echo "https://github.com/your-org/your-repo/actions/runs/$GITHUB_RUN_ID" >> commitmessage.txt

    # Create a multiline string to be used by the git-auto-commit Action
    - name: Set commit message
      id: commit_message_step
      run: |
        echo 'commit_message<<EOF' >> $GITHUB_OUTPUT
        cat commitmessage.txt >> $GITHUB_OUTPUT
        echo 'EOF' >> $GITHUB_OUTPUT

    # Quick and dirty step to get rid of the temporary file holding the commit message
    - run: rm -rf commitmessage.txt

    - uses: stefanzweifel/git-auto-commit-action@v5
      id: commit
      with:
        commit_message: ${{ steps.commit_message_step.outputs.commit_message }}

[hadley]

Thanks for the detailed reply, it's much appreciated.

Just to make sure I'm not missing something obvious, how do you do from a automated commit to the log of the action that generated it? Is there some existing UI that makes my request less useful?

[stefanzweifel]

@hadley There's no simple way to figure out, which Action run created which commit. Or if a Action run produced a commit.
For example, I know for a fact that each workflow run here produced a commit. But on the web UI, there's no indication of this.

Only when I look in the commit log I can see, that some commits have been made through GitHub Actions.

[hadley]

Ok, that's what I thought. I just figured going from commit to log would be a common ask.