search

ChiefGokhlayeh / textidote-action

GitHub Action to lint, spell- and grammar-check LaTeX documents using TeXtidote.
MIT License
7 stars 1 forks source link

Deprecation (set-ouput) and dict #48

Closed cmbant closed 1 year ago

cmbant commented 1 year ago

I get one deprecation warning (shown below). I also cannot figure out why it will not use the dict file, though may not be specific to the action: there is no error, but the report includes words listed with the correct case in the dict.txt file (in the same directory as the main tex). 

/usr/bin/docker run --name a5c76b97d1ceb56f3b4f529cb00b[8](https://github.com/CosmoPars/curl_rotation/actions/runs/4312878349/jobs/7523979103#step:4:9)348534d40_d3a1a8 --label a5c76b --workdir /github/workspace --rm -e "INPUT_ROOT_FILE" -e "INPUT_ARGS" -e "INPUT_WORKING_DIRECTORY" -e "INPUT_REPORT_TYPE" -e "INPUT_REPORT_FILE" -e "INPUT_THRESHOLD_ERROR" -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_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/curl_rotation/curl_rotation":"/github/workspace" a5c76b:[9](https://github.com/CosmoPars/curl_rotation/actions/runs/4312878349/jobs/7523979103#step:4:10)7d1ceb56f3b4f529cb00b8348534d40  "curl.tex" "" "html" "report.html" "" "--check en --dict dict.txt"

Warning: The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
ChiefGokhlayeh commented 1 year ago

Regarding the deprecation warning, I've upgraded to $GITHUB_OUTPUTS as advised by GitHub. I will push a release shortly. Thanks for noting this!

Concerning your trouble with dictionaries, have you tried running TeXtidote outside the GitHub action from command line?

textidote --check en_US --dict <path-to-dict> <your-latex-file>

If TeXtidote still reports spelling mistakes it may be an issue with TeXtidote or LanguageTool. In that case, you'll unfortunately have to take the issue up with those parties.

I personally switched to LTeX for spell-checking while writing. TeXtidote only lints the structure.

ChiefGokhlayeh commented 1 year ago

v5.2.0 has been released. Use tag v5 or latest in your actions.

cmbant commented 1 year ago

Thanks. I think the spell problem may have been a known TeXtidote bug where it silently ignores dictionary files in an unknown character set (or possibly with Unicode BOM).