Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

generate inputs-outputs doc #210

Merged
merged 3 commits into from Mar 20, 2024
Merged

generate inputs-outputs doc #210

merged 3 commits into from Mar 20, 2024

Conversation

2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Mar 15, 2024

  • 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.

- remove static docs/inputs-outputs.md
- gitignore docs/inputs-outputs.md
- add script to generate docs/inputs-outputs.md dynamically on build
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 15, 2024
Copy link
Collaborator

@shenxianpeng shenxianpeng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

It would be nice if we could validate the action.yml before publishing a release.

Hope so :)

@shenxianpeng
Copy link
Collaborator

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
Copy link
Collaborator Author

2bndy5 commented Mar 20, 2024

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.

@2bndy5 2bndy5 merged commit b5db5b1 into main Mar 20, 2024
35 checks passed
@2bndy5 2bndy5 deleted the gen-io-doc branch March 20, 2024 05:10
shenxianpeng added a commit that referenced this pull request Mar 20, 2024
shenxianpeng added a commit that referenced this pull request Mar 20, 2024
2bndy5 added a commit that referenced this pull request Mar 20, 2024
Does the same thing as #210 without maligning action.yml
2bndy5 added a commit that referenced this pull request Mar 20, 2024
Does the same thing as #210 without maligning action.yml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants