feat: workflow for roles readme

[Nemental]

Workflow for creation of roles README.md with aar-doc.

Fixes #694

[rndmh3ro]

Awesome that you did this! Thanks!

I left some comments to simplify the code.

[Nemental]

@rndmh3ro

Awesome that you did this! Thanks!

I left some comments to simplify the code.

Thank you also for your code suggestions - the changes have been implemented.
This was my first GitHub workflow that I worked on. Perfect issue to get me started! ;)

[Nemental]

Maybe I should add a diff or other output step after README creation to show the differences/results?

[rndmh3ro]

Maybe I should add a diff or other output step after README creation to show the differences/results?

I thought about that. In general it's a good idea, so let's keep the git diff action there.

But then I also thought: why not let the action update the README in the pull-request? This way the author of the PR doesn't have to check the diff and correct it, it get's corrected automatically.

Could you therefore try this push-action?

      - name: Push README
        uses: github-actions-x/[email protected]
        with:
          commit-message: 'update ${{ matrix.roles }} readme'
          rebase: true
          files: roles/${{ matrix.roles }}/README.md

With omitting the branch, it should push top the branch where the action gets executed. With omitting the author, it should use the author for the PR, I hope.

[rndmh3ro]

You or I could also do this in another PR, if you want to get this merged, first!

[Nemental]

great thoughts, thanks! I would like to test this myself. I gratefully accept any opportunity to practice GitHub workflow. 😄✌️

[Nemental]

Damn, okay, now it has to work :D

[rndmh3ro]

Maybe just run a git diff without any arguments?

[rndmh3ro]

Seems that pushing to a fork is not easily possible. So instead, let's just push to the master branch when the action is running from master, like you initially did.

[Nemental]

No, I don't want to give up yet. As I can see from the logs, the branch name is the problem. Give me one more try.
I also removed the diff-step, which would no longer be necessary if push worked.

[Nemental]

Why does commit-action want to use 705/merge as branch name...

[Nemental]

This PR will be my personal nemesis.

[rndmh3ro]

Why does commit-action want to use 705/merge as branch name...

The action is running in the dev sec orga, not in your fork. So it checks it out as the number of the PR. The /merge is to show that your changes are merged into master before running the action.

[Nemental]

Why does commit-action want to use 705/merge as branch name...

The action is running in the dev sec orga, not in your fork. So it checks it out as the number of the PR. The /merge is to show that your changes are merged into master before running the action.

If github.head_ref with default github.ref_name don't work, I don't know anymore.

Property name	Type	Description
github.head_ref	string	The head_ref or source branch of the pull request in a workflow run. This property is only available when the event that triggers a workflow run is either pull_request or pull_request_target.
github.ref_name	string	The short ref name of the branch or tag that triggered the workflow run. This value matches the branch or tag name shown on GitHub. For example, feature-branch-1.

[rndmh3ro]

Thanks! Let's see what happens!