kdheepak / panvimdoc

Write documentation in pandoc markdown. Generate documentation in vimdoc.
https://kdheepak.com/panvimdoc
MIT License
263 stars 15 forks source link

Github action workflow fails if repository has a scripts directory #52

Closed mikesmithgh closed 1 year ago

mikesmithgh commented 1 year ago

I ran into an issue using the action kdheepak/panvimdoc@main if my repository also has a scripts directory. It appears that docker is mounting my scripts dir possibly overriding the panvimdoc scripts dir 🤷 ?

I reproduced the issue in a test repo: https://github.com/mikesmithgh/panvimdoc-debug/actions

If I use the v3.0.6 tag, then it works successfully. Let me know if you need any more info, thanks!

2023-09-14T12:31:39.7169987Z ##[command]/usr/bin/docker run --name bf2dcd81e625347379278d2711d1e45a1_dd02f4 --label 94351b --workdir /github/workspace --rm -e "INPUT_VIMDOC" -e "INPUT_PANDOC" -e "INPUT_TREESITTER" -e "INPUT_VERSION" -e "INPUT_TOC" -e "INPUT_DESCRIPTION" -e "INPUT_DEMOJIFY" -e "INPUT_DEDUPSUBHEADINGS" -e "INPUT_IGNORERAWBLOCKS" -e "INPUT_DOCMAPPING" -e "INPUT_DOCMAPPINGPROJECTNAME" -e "INPUT_SHIFTHEADINGLEVELBY" -e "INPUT_INCREMENTHEADINGLEVELBY" -e "HOME" -e "GITHUB_JOB" -e "GITHUB_REF" -e "GITHUB_SHA" -e "GITHUB_REPOSITORY" -e "GITHUB_REPOSITORY_OWNER" -e "GITHUB_REPOSITORY_OWNER_ID" -e "GITHUB_RUN_ID" -e "GITHUB_RUN_NUMBER" -e "GITHUB_RETENTION_DAYS" -e "GITHUB_RUN_ATTEMPT" -e "GITHUB_REPOSITORY_ID" -e "GITHUB_ACTOR_ID" -e "GITHUB_ACTOR" -e "GITHUB_TRIGGERING_ACTOR" -e "GITHUB_WORKFLOW" -e "GITHUB_HEAD_REF" -e "GITHUB_BASE_REF" -e "GITHUB_EVENT_NAME" -e "GITHUB_SERVER_URL" -e "GITHUB_API_URL" -e "GITHUB_GRAPHQL_URL" -e "GITHUB_REF_NAME" -e "GITHUB_REF_PROTECTED" -e "GITHUB_REF_TYPE" -e "GITHUB_WORKFLOW_REF" -e "GITHUB_WORKFLOW_SHA" -e "GITHUB_WORKSPACE" -e "GITHUB_ACTION" -e "GITHUB_EVENT_PATH" -e "GITHUB_ACTION_REPOSITORY" -e "GITHUB_ACTION_REF" -e "GITHUB_PATH" -e "GITHUB_ENV" -e "GITHUB_STEP_SUMMARY" -e "GITHUB_STATE" -e "GITHUB_OUTPUT" -e "RUNNER_OS" -e "RUNNER_ARCH" -e "RUNNER_NAME" -e "RUNNER_ENVIRONMENT" -e "RUNNER_TOOL_CACHE" -e "RUNNER_TEMP" -e "RUNNER_WORKSPACE" -e "ACTIONS_RUNTIME_URL" -e "ACTIONS_RUNTIME_TOKEN" -e "ACTIONS_CACHE_URL" -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/panvimdoc-debug/panvimdoc-debug":"/github/workspace" 94351b:f2dcd81e625347379278d2711d1e45a1  "--project-name" "panvimdoc" "--input-file" "README.md" "--vim-version" "NVIM v0.8.0" "--toc" "true" "--description" "" "--dedup-subheadings" "true" "--demojify" "false" "--treesitter" "true" "--ignore-rawblocks" "true" "--doc-mapping-project-name" "true" "--doc-mapping" "false" "--shift-heading-level-by" "0" "--increment-heading-level-by" "0"
2023-09-14T12:31:40.0114910Z SCRIPTS
2023-09-14T12:31:40.0136790Z pandoc --citeproc --shift-heading-level-by=0 --metadata=project:panvimdoc --metadata=vimversion:NVIM v0.8.0 --metadata=toc:true --metadata=description: --metadata=dedupsubheadings:true --metadata=ignorerawblocks:true --metadata=docmapping:false --metadata=docmappingproject:true --metadata=treesitter:true --metadata=incrementheadinglevelby:0 --lua-filter=scripts/include-files.lua --lua-filter=scripts/skip-blocks.lua -t scripts/panvimdoc.lua README.md -o doc/panvimdoc.txt
2023-09-14T12:31:40.0215623Z Error running Lua:
2023-09-14T12:31:40.0217634Z cannot open scripts/panvimdoc.lua: No such file or directory
kdheepak commented 1 year ago

Thanks for reporting!

This is probably related to this https://github.com/kdheepak/panvimdoc/pull/44 Or https://github.com/kdheepak/panvimdoc/pull/43

And we might have to revert one of them. Unfortunately I'm going to be unavailable for the next few days to fix this. I can look at it next week.

mikesmithgh commented 1 year ago

Thanks for reporting!

This is probably related to this #44 Or #43

And we might have to revert one of them. Unfortunately I'm going to be unavailable for the next few days to fix this. I can look at it next week.

sounds good 👍 I can workaround for now so not blocking me 🙂

kdheepak commented 1 year ago

This should be resolved now!

mikesmithgh commented 1 year ago

@kdheepak Thanks! I confirmed it works as expected now 👍