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

fix!: remove broken configPath option #428

Merged
merged 6 commits into from
Apr 30, 2023
Merged

fix!: remove broken configPath option #428

merged 6 commits into from
Apr 30, 2023

Conversation

FabianLars
Copy link
Member

@FabianLars FabianLars commented Mar 30, 2023

This may seem extreme at first but let's be honest, this option never did what you expect and removing it will move it closer to the local cli usage.

TODO:

  • Check if setting just projectPath is enough, for example if a repo contains multiple tauri projects, or none.
  • Check the docs and general behavior of projectPath
  • Add support for reading json strings in the --config flag -> this may be outsourced to a second PR.

Edit: A few successful runs:
https://github.com/FabianLars/tauri-action-testbed/actions/runs/4665698961
https://github.com/FabianLars/tauri-action-testbed/actions/runs/4665905996

@FabianLars
Copy link
Member Author

@lucasfernog 2 questions:

  • What do you think about this PR's idea? Do you have any arguments to keep the configPath option? please consider that the option currently doesn't really work (at least not as it is documented which is partly my bad but it was also wrong before i reworded the readme)
  • What are your thoughts about projectPath when github supports a working-dir option natively? I'm asking because the action and tauri itself use a different root for the --config option, of course this is an easy fix but the less custom handling the better imo

@lucasfernog
Copy link
Member

The configPath input was meant for repositories that only have a frontend and only need the basic Tauri template to work (that's why we also have the option of running tauri init automatically). So since you're not commiting the Tauri template, we offer the option to use the tauri.conf.json file from another path.

I think this use case was never perfectly implemented and it's ok to slowly remove it. We'll probably implement this kind of thing with a different service.

About the projectPath thing: I think working-directory only works when running shell commands, and custom actions must implement an input for this.
@FabianLars

@FabianLars
Copy link
Member Author

The configPath input was meant for repositories that only have a frontend and only need the basic Tauri template to work (that's why we also have the option of running tauri init automatically). So since you're not commiting the Tauri template, we offer the option to use the tauri.conf.json file from another path.

Yeah that doesn't work right now. I meant to fix it but thought it'd be way easier to just remove this option and let users use the normal --config option to overwrite the default one, this way it would be closer to "native tauri" making it at least easier to maintain for us, maybe even easier to use for some users.

About the projectPath thing: I think working-directory only works when running shell commands, and custom actions must implement an input for this.

Gonna check that but sounds about right 🤔

@FabianLars FabianLars marked this pull request as ready for review April 11, 2023 10:10
@FabianLars FabianLars merged commit 240732d into dev Apr 30, 2023
@FabianLars FabianLars deleted the remove-configpath branch April 30, 2023 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Multiple tauri.conf.json files cause issues even if configPath is defined
2 participants