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

feat: Reusable Workflow Docs #304

Merged
merged 12 commits into from
Dec 20, 2024
Merged

feat: Reusable Workflow Docs #304

merged 12 commits into from
Dec 20, 2024

Conversation

clay-lake
Copy link
Contributor

Features included in this PR

  • Index for README.md
  • Brief documentation for Test-Rock and Build-Rock reusable workflows.

@clay-lake clay-lake requested a review from zhijie-yang December 5, 2024 15:20
Copy link
Collaborator

@zhijie-yang zhijie-yang left a comment

Choose a reason for hiding this comment

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

This looks overall nice to me. However, please make the orders of the description of the workflow inputs consistent. We can follow the documentation styles above, by putting them into tables with the columns parameter, required, type and description.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@zhijie-yang zhijie-yang left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks!

@zhijie-yang zhijie-yang self-assigned this Dec 20, 2024
@clay-lake clay-lake merged commit 3539269 into main Dec 20, 2024
25 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants