Skip to content

[BUG] deploy_docs_master does not use a config file for CMinx #22

@AutonomicPerfectionist

Description

@AutonomicPerfectionist

Describe the bug
Based on repos using the deploy_docs_master action, it seems it is assumed that CMinx will generate using a config file in the repo using the action. However, the command I see here:

cminx \
"${cmake_source_dir}/${api_docs_module}" \
-o "${build_api_docs_dir}/${api_docs_module}" \
-r -p ${api_docs_module}

Does not use the -s switch to use a config file. I would suggest adding an input to the action for the location of the config file, with a default of empty string, and if the value is an empty string do not use the -s flag.

Additionally, the command-line flags given to CMinx will override the values given in the config. For the most part these seem fine, but users may want to change the prefix option in the config. It's debatable though

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions