How to write a multiline commit_message #279

smallprogram · 2023-01-07T07:17:55Z

smallprogram
Jan 7, 2023

For example, I have a yml, similar to this form:

name: "test"
jobs:
  stale:
    runs-on: ubuntu-latest
    steps:

      - name: Checkout
        uses: actions/checkout@main

       - name: Update 1
        run: |
          sed -i "8c PKG_VERSION:=1.1" Makefile
          cd
          echo "Version Update Title" >> commitmessage.txt

      - name: Update 1
        run: |
          sed -i "8c PKG_VERSION:=1.1" Makefile
          cd
          echo "Makefile version update 1.1" >> commitmessage.txt

      - name: Update 2
        run: |
          sed -i "12c PKG_VERSION:=1.2" Makefile
          cd
          echo "Makefile version update 1.2" >> commitmessage.txt

      - name: Git Auto Commit
        uses: stefanzweifel/git-auto-commit-action@v4.16.0
        id: commit
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          commit_message: ./commitmessage.txt
          branch: packages

Is it possible to put a multi-line commit message into a file, and then assign the content of this file to commit_message, so as to realize a multi-line commit message.

But I tried it, but it doesn't seem to work. Is there any way to achieve a multi-line commit message?

Answered by stefanzweifel

Jan 7, 2023

The value passed to commit_message must be a string. Actions isn't clever enough to see that you're referencing a file here.
I haven't tested the workflow below, but it should technically work:
(Added a test to cover this.)

name: "test"
jobs:
  stale:
    runs-on: ubuntu-latest
    steps:

      - name: Checkout
        uses: actions/checkout@main

       - name: Update 1
        run: |
          sed -i "8c PKG_VERSION:=1.1" Makefile
          cd
          echo "Version Update Title" >> commitmessage.txt

      - name: Update 1
        run: |
          sed -i "8c PKG_VERSION:=1.1" Makefile
          cd
          echo "Makefile version update 1.1" >> commitmessage.txt

      - name: Update…

View full answer

stefanzweifel · 2023-01-07T10:56:23Z

stefanzweifel
Jan 7, 2023
Maintainer

The value passed to commit_message must be a string. Actions isn't clever enough to see that you're referencing a file here.
I haven't tested the workflow below, but it should technically work:
(Added a test to cover this.)

name: "test"
jobs:
  stale:
    runs-on: ubuntu-latest
    steps:

      - name: Checkout
        uses: actions/checkout@main

       - name: Update 1
        run: |
          sed -i "8c PKG_VERSION:=1.1" Makefile
          cd
          echo "Version Update Title" >> commitmessage.txt

      - name: Update 1
        run: |
          sed -i "8c PKG_VERSION:=1.1" Makefile
          cd
          echo "Makefile version update 1.1" >> commitmessage.txt

      - name: Update 2
        run: |
          sed -i "12c PKG_VERSION:=1.2" Makefile
          cd
          echo "Makefile version update 1.2" >> commitmessage.txt

+     - name: Read Commit Message
+       id: commit_message_step
+       run: |
+         echo "commit_message=$(cat commitmessage.txt)" >> $GITHUB_OUTPUT;

      - name: Git Auto Commit
        uses: stefanzweifel/git-auto-commit-action@v4.16.0
        id: commit
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
-         commit_message: ./commitmessage.txt
+         commit_message: ${{ steps.commit_message_step.outputs.commit_message }}
          branch: packages

The "Read Commit Message"-step outputs the value of commitmessage.txt and stores the value to a commit_message "variable" that can be referenced in the workflow later on.

The commit step is then updated to use the commit_message-value from the variable.

3 replies

smallprogram Jan 7, 2023
Author

it's don't work...

Run cd && cd packages         
  cd && cd packages         
  echo "commit_message=$(cat commit_messages.txt)" >> $GITHUB_OUTPUT;
  shell: /usr/bin/bash -e {0}
  env:
    TZ: Asia/Shanghai
Error: Unable to process file command 'output' successfully.
Error: Invalid format 'brook: update to [2](https://github.com/smallprogram/openwrt-passwall/actions/runs/3862387214/jobs/6583924158#step:28:2)02[3](https://github.com/smallprogram/openwrt-passwall/actions/runs/3862387214/jobs/6583924158#step:28:3)0101'

https://github.com/smallprogram/openwrt-passwall/actions/runs/3862441589/jobs/6584014712

smallprogram Jan 7, 2023
Author

workflow code:

      cd && cd packages
      echo "xray-plugin: update to $New_PKG_VERSION" >> commit_messages.txt


  - name: Read Commit Message
    id: commit_message_step
    run: |
      cd && cd packages         
      echo "commit_message=$(cat commit_messages.txt)" >> $GITHUB_OUTPUT;

  - name: Git Auto Commit
    uses: stefanzweifel/git-auto-commit-action@v4.16.0
    id: commit
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    with:
      commit_message: ${{ steps.commit_message_step.outputs.commit_message }}
      branch: packages

https://github.com/smallprogram/openwrt-passwall/blob/13d11c94de9897736978f3ce06c7a43026cfd0d9/.github/workflows/AUTO%20UPDATE%20PACKAGES%20PKG_VERSION%20AND%20PKG_HASH.yml#L396-L413

stefanzweifel Jan 7, 2023
Maintainer

I'm not sure what the issue here is. From reading the GitHub Actions log it's not clear, where the error actually is. :(

echo "{name}={value}" >> $GITHUB_OUTPUT is the syntax to set output variables in GitHub Actions:
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter

I've used this logic before in another project to extract the release date from a git tag. (::set-output name={name}::value syntax is deprecated, but the logic is the same as in my previous example)
https://github.com/stefanzweifel/git-auto-commit-action-demo-app/blob/main/.github/workflows/update-changelog.yml#L27

smallprogram · 2023-01-14T05:54:08Z

smallprogram
Jan 14, 2023
Author

I try this:

- name: Read Commit Message
        id: commit_message_step
        run: |
          cd && cd packages
          cm=$(cat commit_messages.txt)
          cm="${cm//'%'/'%25'}"
          cm="${cm//$'\n'/'%0A'}"
          cm="${cm//$'\r'/'%0D'}"         
          echo -e "commit_message=$cm" >> $GITHUB_OUTPUT;
          echo $(cat commit_messages.txt)

but the commit message is this:

after I try this:

      - name: Initialization environment
        run: |
          cd && mkdir -p packages && cd packages
          echo "<<EOF" >> commit_messages.txt
          echo "auto update packages" >> commit_messages.txt

      # some commit message code      

      - name: Read Commit Message
        id: commit_message_step
        run: |
          cd && cd packages
          echo "EOF" >> commit_messages.txt
          cm=$(cat commit_messages.txt)
          cm="${cm//'%'/'%25'}"
          cm="${cm//$'\n'/'%0A'}"
          cm="${cm//$'\r'/'%0D'}"         
          echo -e "commit_message=$cm" >> $GITHUB_OUTPUT;
          echo $(cat commit_messages.txt)

but the commit message is this:

I want commit message like this:

can anyone help me............................

2 replies

stefanzweifel Jan 14, 2023
Maintainer

I should have pointed you to the "Multiline Strings" parts of the GitHub Actions documentation one section above "Setting an output parameter".
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings

Apparently there is a custom syntax for multiline strings.

I've added the following steps to my example repo workflow.

    # Building a multiline commit message
    # Adjust to your liking
    - run: echo "Commit Message 1" >> commitmessage.txt
    - run: echo "Commit Message 2" >> commitmessage.txt
    - run: echo "Commit Message 3" >> commitmessage.txt

    - 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@v4
      id: commit
      with:
        commit_message: ${{ steps.commit_message_step.outputs.commit_message }}

This is the workflow run and this is the resulting commit: stefanzweifel/git-auto-commit-action-demo-app@82c2490

I think that's exactly what you want @smallprogram, right?

I will add an example to the README for multiline commits.

smallprogram Jan 14, 2023
Author

Thank you very much, this problem is solved. Thank you for your help

Jason2866 · 2023-01-14T13:09:14Z

Jason2866
Jan 14, 2023

This is working for me with a used github actions. Probably this way will work here too

 - name: Build commit message
      id: step_one
      run: |
        tas_com_tmp1=$(curl https://raw.githubusercontent.com/arendst/Tasmota-firmware/action-development/trigger.txt)
        tas_com_tmp="Based on https://github.com/arendst/Tasmota/commit/${tas_com_tmp1}"
        echo "tas_com=$tas_com_tmp" >> $GITHUB_ENV
    - name: Display files to transfer
      run: ls -R ./*
    - name: Push Firmware files to tmp_copy repo
      uses: Jason2866/copy_file_to_another_repo_action@main
      env:
        API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
      with:
        source_file: 'firmware'
        destination_repo: 'Jason2866/tmp_copy'
        destination_branch: 'firmware'
        user_email: 'github-actions@github.com'
        user_name: 'github-actions'
        commit_message: '${{ env.tas_com }}'

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

How to write a multiline commit_message #279

{{title}}

Replies: 3 comments 5 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

How to write a multiline commit_message #279

smallprogram Jan 7, 2023

Replies: 3 comments · 5 replies

stefanzweifel Jan 7, 2023 Maintainer

smallprogram Jan 7, 2023 Author

smallprogram Jan 7, 2023 Author

stefanzweifel Jan 7, 2023 Maintainer

smallprogram Jan 14, 2023 Author

stefanzweifel Jan 14, 2023 Maintainer

smallprogram Jan 14, 2023 Author

Jason2866 Jan 14, 2023

smallprogram
Jan 7, 2023

Replies: 3 comments 5 replies

stefanzweifel
Jan 7, 2023
Maintainer

smallprogram Jan 7, 2023
Author

smallprogram Jan 7, 2023
Author

stefanzweifel Jan 7, 2023
Maintainer

smallprogram
Jan 14, 2023
Author

stefanzweifel Jan 14, 2023
Maintainer

smallprogram Jan 14, 2023
Author

Jason2866
Jan 14, 2023