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 #216

Merged
merged 3 commits into from
Mar 26, 2024
Merged

generate inputs-outputs doc #216

merged 3 commits into from
Mar 26, 2024

Conversation

2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Mar 20, 2024

Does the same thing as #210 without maligning action.yml

@2bndy5 2bndy5 added the documentation Improvements or additions to documentation label Mar 20, 2024
@2bndy5 2bndy5 marked this pull request as draft March 21, 2024 13:42
@2bndy5 2bndy5 marked this pull request as ready for review March 21, 2024 15:32
@2bndy5
Copy link
Collaborator Author

2bndy5 commented Mar 21, 2024

I added some changes to the python scripts in docs/ that will emit warning/error annotations about differences in action.yml vs docs/action.yml. As stated in f94df13 commit message:

This is just some future proofing.
The GH warning-annotations will notify new contributions that certain fields are missing.

In a way, this kind of lints action.yml and docs/action.yml (specifically for our usage).


New IO contributions to the action.yml (like in #213) will see an annotation saying docs/action.yml needs updating. For those that can't see our drafted releases, they can simply add latest as the minimum-version:

# in docs/action.yml

inputs:
  # ...
  jobs:
    minimum-version: latest

And we can adjust it from main before deploying the release.

@2bndy5 2bndy5 linked an issue Mar 21, 2024 that may be closed by this pull request
@cpp-linter cpp-linter deleted a comment from github-actions bot Mar 21, 2024
2bndy5 added 3 commits March 25, 2024 14:00
This is just some future proofing.
The GH warning-annotations will notify new contributions that certain fields are missing.

In a way, this kind of lints action.yml and docs/action.yml (specifically for our usage).
Copy link
Contributor

Cpp-Linter Report ⚠️

Some files did not pass the configured checks!

clang-format reports: 2 file(s) not formatted
  • docs/examples/demo/demo.cpp
  • docs/examples/demo/demo.hpp
clang-tidy reports: 7 concern(s)

Have any feedback or feature suggestions? Share it here.

@2bndy5
Copy link
Collaborator Author

2bndy5 commented Mar 25, 2024

I see the updated test CI had no problems with the changes in this branch 🎉

@2bndy5 2bndy5 requested a review from shenxianpeng March 25, 2024 19:05
@2bndy5 2bndy5 merged commit d622b2b into main Mar 26, 2024
35 checks passed
@2bndy5 2bndy5 deleted the regen-io-doc branch March 26, 2024 03:58
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.

generate the "Inputs and Outputs" page using action.yml
2 participants