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

docs: Add example that demonstrates multiple search queries #93

Merged
merged 1 commit into from
Aug 2, 2023

Conversation

Okabe-Junya
Copy link
Contributor

@Okabe-Junya Okabe-Junya commented Aug 2, 2023

resolved #49

WHAT I CHANGED

  • added an example to the README. This consolidates the metrics from multiple repos into a single report.

FUTURE WORK

This example is working well, but there may be some potential problems. These might become challenges in the future.

  • Unexpected references might occur and be treated as spam (as shown in the example I provided in the issue).
  • The use of the chown command within the workflow might pose a security risk. (I'm not a security expert, so I don't know the details, but...)
  • The workflow has become a bit verbose. It might be more considerate to provide functionality to make it shorter.
  • Including private repos might be a bit challenging. Is there a good way to deal with this?

@zkoppert zkoppert added the enhancement New feature or request label Aug 2, 2023
Copy link
Member

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

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

Looks fantastic! Thanks for adding this along with all your other submissions! Greatly appreciated! 🎉

@zkoppert zkoppert merged commit f209436 into github:main Aug 2, 2023
4 checks passed
@Okabe-Junya Okabe-Junya deleted the junya/docs/multi-repo-search branch August 2, 2023 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: README example that demonstrates multiple search queries with 1 report
2 participants