dineshsonachalam/markdown-autodocs

Windows support?

csm10495 opened this issue · 1 comments

I was using this in a windows flow and thought it was working but then noticed:

Run wget https://raw.githubusercontent.com/dineshsonachalam/markdown-autodocs/master/action.py
  
--2023-01-28 02:06:40--  https://raw.githubusercontent.com/dineshsonachalam/markdown-autodocs/master/action.py
Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 185.199.108.[13](https://github.com/csm10495/pyhtcc/actions/runs/4029633411/jobs/6927728105#step:6:15)3, [18](https://github.com/csm10495/pyhtcc/actions/runs/4029633411/jobs/6927728105#step:6:20)5.[19](https://github.com/csm10495/pyhtcc/actions/runs/4029633411/jobs/6927728105#step:6:21)9.109.133, 185.199.110.133, ...
Connecting to raw.githubusercontent.com (raw.githubusercontent.com)|185.199.108.133|:443... connected.
HTTP request sent, awaiting response... [20](https://github.com/csm10495/pyhtcc/actions/runs/4029633411/jobs/6927728105#step:6:22)0 OK
Length: 3579 (3.5K) [text/plain]
Saving to: 'action.py'

     0K ...                                                   100% 10.1M=0s

20[23](https://github.com/csm10495/pyhtcc/actions/runs/4029633411/jobs/6927728105#step:6:25)-01-28 02:06:40 (10.1 MB/s) - 'action.py' saved [3579/3579]

Run python3 action.py -repo 'csm10495/pyhtcc' -access_token '***' -commit_author 'csm10495 <csm10495@users.noreply.github.com>' -commit_user_email 'actions@github.com' -commit_message 'Apply automatic changes' -branch 'master' -output_file_paths '[./README.md]' -categories '[code-block,json-to-html-table,workflow-artifact-table,markdown]'
1.0.1[33](https://github.com/csm10495/pyhtcc/actions/runs/4029633411/jobs/6927728105#step:6:36): Pulling from dineshsonachalam/markdown-autodocs
image operating system "linux" cannot be used on this platform
Unable to find image 'dineshsonachalam/markdown-autodocs:1.0.133' locally
1.0.133: Pulling from dineshsonachalam/markdown-autodocs
docker: image operating system "linux" cannot be used on this platform.
See 'docker run --help'.
The system cannot find the file specified.
error: pathspec 'automatic' did not match any file(s) known to git
error: pathspec 'changes'' did not match any file(s) known to git
Everything up-to-date
git config user.name 'csm10495 <csm10495@users.noreply.github.com>'
git config user.email 'actions@github.com'
git add ./README.md
git commit -m 'Apply automatic changes' ./README.md
git push origin master

Should this work on Windows? If not can we at least have it fail in a case like this (docker failure)? ... or make it work in Windows :) ?

Thanks!

Until/if its officially working, I'm using this as a workaround:

      - uses: actions/setup-node@v3

      - name: Markdown autodocs
        shell: bash
        run: |
          npm install -g markdown-autodocs
          markdown-autodocs -c code-block -o README.md
          git commit README.md -m "Updating readme" || true
          git push origin master || true

Basically i setup node, install this module, use it, make commit/push. The || true accounts for if changes were not made, so nothing to commit/nothing to push.