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

ci: add a check that the usage is up-to-date #46

Merged
merged 3 commits into from
Mar 7, 2025
Merged

ci: add a check that the usage is up-to-date #46

merged 3 commits into from
Mar 7, 2025

Conversation

nh13
Copy link
Member

@nh13 nh13 commented Mar 7, 2025

Also, update the usage as a result.

Fixes #44.

update-docs.sh Outdated
@@ -0,0 +1,12 @@
#!/bin/bash
Copy link
Member Author

Choose a reason for hiding this comment

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

where should this live? Is the top-level fine?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd put it in .github/scripts/ or .github/workflows/scripts/

Looks like GHA permits configuring the working directory accordingly too: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/adding-scripts-to-your-workflow

@nh13 nh13 force-pushed the ci/readme-usage branch 4 times, most recently from 9d64618 to e259f21 Compare March 7, 2025 17:49
Also, update the usage as a result and update checkout actions to v4.
@nh13 nh13 force-pushed the ci/readme-usage branch from e259f21 to cb1315d Compare March 7, 2025 18:13
@nh13 nh13 linked an issue Mar 7, 2025 that may be closed by this pull request
Copy link
Contributor

@msto msto left a comment

Choose a reason for hiding this comment

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

lgtm!

update-docs.sh Outdated
@@ -0,0 +1,12 @@
#!/bin/bash
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd put it in .github/scripts/ or .github/workflows/scripts/

Looks like GHA permits configuring the working directory accordingly too: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/adding-scripts-to-your-workflow

@nh13 nh13 merged commit 2207abf into main Mar 7, 2025
8 checks passed
@nh13 nh13 deleted the ci/readme-usage branch March 7, 2025 21:17
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.

Auto-generate usage in README via GitHub actions Proper command-line usage for fqgrep
2 participants