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(/github/commits): support filter by path #435

Merged
merged 3 commits into from
Aug 23, 2024

Conversation

jnurthen
Copy link
Contributor

@jnurthen jnurthen commented Aug 2, 2024

Closes #434
Part of speced/respec#4754

Adds an optional path parameter to the GH commits interface.
Usage allows multiple specs hosted in a monorepo to specific either a folder or a file/folder and only return commits against that file.
Usage will require a corresponding change to gh-changelog in respec to enable this ability

@jnurthen
Copy link
Contributor Author

jnurthen commented Aug 2, 2024

@sidvishnoi please let me know if this looks like a reasonable direction.

Copy link
Member

@sidvishnoi sidvishnoi 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 great to me. Just need to add some safety checks to path to avoid path traversal via the DiskCache.
Thanks @jnurthen

@sidvishnoi sidvishnoi changed the title add support for path param for GH commits feat(/github/commits): support filter by path Aug 5, 2024
@sidvishnoi sidvishnoi marked this pull request as ready for review August 23, 2024 07:02
Copy link
Member

@sidvishnoi sidvishnoi left a comment

Choose a reason for hiding this comment

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

LGTM now.
I addressed the path security issues in #440 and #441.

@sidvishnoi sidvishnoi merged commit 4117d66 into speced:main Aug 23, 2024
2 checks passed
@jnurthen
Copy link
Contributor Author

LGTM now. I addressed the path security issues in #440 and #441.

Thanks so much!

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.

Add path / file to the github commit APIs
2 participants