composite example does not run in Windows

[robert-s-lee]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/creating-actions/creating-a-composite-action

What part(s) of the article would you like to see updated?

Creating an action metadata file
works for ubunut and mac. For windows, / does not work.

suggest the following change:

        - run: echo "${{ github.action_path }}" >> $GITHUB_PATH
          shell: bash          
        - run: goodbye.sh
          shell: bash

Additional information

No response

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[ramyaparimi]

@robert-s-lee
Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

[hubwriter]

@robert-s-lee - Thank for raising this issue. I agree, your suggested change would avoid using the forward slash so would be usable across the OSs.

The change required is, therefore, as follows.

On lines 87-88 of the docs file content/actions/creating-actions/creating-a-composite-action.md, change:

- run: ${{ github.action_path }}/goodbye.sh
  shell: bash

to:

- run: echo "${{ github.action_path }}" >> $GITHUB_PATH
  shell: bash          
- run: goodbye.sh
  shell: bash

[kumar-kalyan]

Hi, can I get started with this issue

[hubwriter]

@kum9748ar

Hi, can I get started with this issue

Please do! 🙇‍♂️

[allprogrammers]

Hello, Can I please work on this?

If yes, I need help understanding a few things.

Do I just copy paste the suggestion in the code ?

or do I create an example for windows separately? because bash and *.sh files don't run in windows.

the files can be .bat and can be run with either powershell or command prompt. power shell doesn't differentiate between / and \ but cmd does.

or there can be *.ps1 scripts

[ramyaparimi]

@allprogrammers One of the writers reviewed and suggested a change for this issue in this comment. You can follow this writer's review to open a PR with a fix ✨