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

Change field name of CommitFile #3515

Closed

Conversation

yongjoon-km
Copy link

  • PR Description

  • Change Name field to Path in CommitFile and removed the original TODO comment.

  • Please check if the PR fulfills these requirements

  • Cheatsheets are up-to-date (run go generate ./...)
  • Code has been formatted (see here)
  • Tests have been added/updated (see here for the integration test guide)
  • Text is internationalised (see here)
  • Docs (specifically docs/Config.md) have been updated if necessary
  • You've read through your own file changes for silly mistakes etc

Change `Name` field to `Path` in CommitFile and removed the original
TODO comment.
@stefanhaller
Copy link
Collaborator

Nice, thanks.

This is a breaking change for custom commands though, so we need to something similar to what we did in 7e14d88 and provide a CommitFile wrapper that has both Name and Path.

Also, Name is mentioned in docs/Custom_Command_Keybindings.md, this needs to be adapted as well.

Finally, please don't merge master into your branch! Rebase onto master instead.

@yongjoon-km
Copy link
Author

yongjoon-km commented Apr 23, 2024

Nice, thanks.

This is a breaking change for custom commands though, so we need to something similar to what we did in 7e14d88 and provide a CommitFile wrapper that has both Name and Path.

Also, Name is mentioned in docs/Custom_Command_Keybindings.md, this needs to be adapted as well.

Finally, please don't merge master into your branch! Rebase onto master instead.

Thanks for the feedback.

Also, Name is mentioned in docs/Custom_Command_Keybindings.md, this needs to be adapted as well.

I read about the Custom Command Keybindings feature. I'm sorry I wasn't aware of this. This pr will break the user's custom command with the SelectedCommitFile placeholder. Like your example commit shared, I think the wrapping seems necessary.

I think keeping the Name field of the CommitFile model is one of the safest options because it is publicly available.

@yongjoon-km yongjoon-km closed this May 5, 2024
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.

None yet

2 participants