generate inputs-outputs doc

cpp-linter / cpp-linter-action

A Github Action for linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of file-annotations, thread-comments, workflow step-summary, and Pull Request reviews.

https://cpp-linter.github.io/cpp-linter-action/

MIT License

87 stars 20 forks source link

generate inputs-outputs doc #210

Closed 2bndy5 closed 3 months ago

2bndy5 commented 3 months ago

use mkdocs-gen-files plugin
remove static docs/inputs-outputs.md
gitignore docs/inputs-outputs.md
add script to generate docs/inputs-outputs.md dynamically on build

[!CAUTION] This adds metadata/fields to the action.yml that is not used by github actions.
inputs:
  style:
    minimum-version: '1.2.0'
I don't see anything in the github docs that forbids the use of superfluous fields in action.yml. It would be nice if we could validate the action.yml before publishing a release.

shenxianpeng commented 3 months ago

From filed minimum-version I learned we should follow semantic versioning more strictly to release a minor version when a new parameter or feature is delivered.

2bndy5 commented 3 months ago

I agree, and we've been doing that for the most part. Some minimum-versions that are set to a patch bump are the result of bug fixes or patched behavior.

For example, we didn't do a minor version bump for new input no-lgtm because that was a flag to restore previous thread-comments behavior while retaining the capability introduced in the minor version bump for step-summary.