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

Add a .kiotaignore file so users can add which files Kiota shouldn't change #6047

Open
maisarissi opened this issue Jan 22, 2025 · 1 comment
Labels
type:feature New experience request

Comments

@maisarissi
Copy link
Contributor

maisarissi commented Jan 22, 2025

Is your feature request related to a problem? Please describe the problem.

Based on the discussion in the #5977 (comment), we can introduce a new .ignore file so users can add patters and specific files Kiota shouldn't change when generating/regenerating.

This would allow folks to add project files to a client/plugin output directory and not get their files deleted/changed when regenerating.
This would also allow folks to manual edit any generated file and not get the content overridden by Kiota, like slightly changing a model or a request builder.

Describe the solution you'd like

Provide users with the ability to add a .ignore file so Kiota would use it when generating/regenerating and not change the content of that files.

When creating a client/plugin to an output folder that contains files already, Kiota should create the .ignore files with the whole content of the folder.

Additional context

This will be considered and prioritized based on community feedback and demand. So please, upvote if you would like that feature available.

@maisarissi maisarissi added status:waiting-for-triage An issue that is yet to be reviewed or assigned type:feature New experience request labels Jan 22, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage 🔍 in Kiota Jan 22, 2025
@baywet
Copy link
Member

baywet commented Jan 22, 2025

To other team members reading this, I want to make something clear from the discussion: this is not committed to, we're simply trying to gather community feedback here.

Another aspect from our discussion is that while this is a common pattern, discoverability by the user will be a challenge, which is why we're not committing to doing this yet.

@baywet baywet removed the status:waiting-for-triage An issue that is yet to be reviewed or assigned label Jan 22, 2025
@baywet baywet moved this from Needs Triage 🔍 to Waits for author 🔁 in Kiota Jan 22, 2025
@baywet baywet moved this from Waits for author 🔁 to Proposed 💡 in Kiota Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature New experience request
Projects
Status: Proposed 💡
Development

No branches or pull requests

2 participants