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

Improve error reporting on config migration #4210

Merged
merged 1 commit into from
Jan 30, 2025

Conversation

kas2020-commits
Copy link
Contributor

  • PR Description

closes #4209

  • 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)
  • If a new UserConfig entry was added, make sure it can be hot-reloaded (see here)
  • Docs have been updated if necessary
  • You've read through your own file changes for silly mistakes etc

@kas2020-commits
Copy link
Contributor Author

I hope I'm not bothering with this small change I just want to save someone from an annoying debugging session in the future that I went through. Feel free to change the strings to your liking if you don't like the messages.

@stefanhaller
Copy link
Collaborator

The logging is a little bit on the verbose side now for my taste, but if it helps, I'm ok with it.

I wonder if we can do better though:

  • it would be nice to report which config settings were migrated, so that users can fix their config file manually if they want to
  • I'm actually wondering if we need to abort at all when rewriting the config fails. We could just report the error (in some way) and then continue launching. After all, the config was migrated properly in memory, so running lazygit should behave correctly at that point; the worst that happens is that there is a slight delay every time they start lazygit, because the config needs to be migrated again every time. But I'm not even sure this would be noticeable.

These could be done in separate PRs of course (if we find them important enough), I'm happy to merge this one as is. Tagging @jesseduffield in case he has more thoughts.

@jesseduffield
Copy link
Owner

@stefanhaller I agree, those suggestions sound good. This PR also LGTM. I don't mind the verbosity because this will only happen after upgrading lazygit

@stefanhaller
Copy link
Collaborator

@kas2020-commits CI reported two problems: a spelling error (fixed by 5e1c23b) and an actual behavior error (fixed by ddd682e). Did you even test the feature? I don't think the success reporting would have worked. (I didn't test it myself.)

@kas2020-commits kas2020-commits force-pushed the patch-1 branch 2 times, most recently from 5a17ba6 to 040620d Compare January 28, 2025 03:09
@kas2020-commits
Copy link
Contributor Author

@stefanhaller my bad, I wrote the patch online without double-checking the fmt.Println sig (not a go dev)

@stefanhaller
Copy link
Collaborator

my bad, I wrote the patch online

Oh, ok. I usually trust people to have run their code at least once to see if it even does what they want. Good to know that I can't count on that.

Tested it myself now, seems to work. Thanks for the contribution.

@stefanhaller stefanhaller merged commit 49f8dc2 into jesseduffield:master Jan 30, 2025
15 checks passed
@kas2020-commits kas2020-commits deleted the patch-1 branch February 2, 2025 20:06
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Feb 25, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [jesseduffield/lazygit](https://github.com/jesseduffield/lazygit) | minor | `v0.45.2` -> `v0.47.1` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>jesseduffield/lazygit (jesseduffield/lazygit)</summary>

### [`v0.47.1`](https://github.com/jesseduffield/lazygit/releases/tag/v0.47.1)

[Compare Source](jesseduffield/lazygit@v0.46.0...v0.47.1)

<!-- Release notes generated using configuration in .github/release.yml at v0.47.1 -->

#### What's Changed

##### Maintenance ⚙️

-   Fix race condition with reselecting the focused branch and rendering by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4268

**Full Changelog**: jesseduffield/lazygit@v0.47.0...v0.47.1

### [`v0.46.0`](https://github.com/jesseduffield/lazygit/releases/tag/v0.46.0)

[Compare Source](jesseduffield/lazygit@v0.45.2...v0.46.0)

It's time for another Lazygit release! Thanks to all who contributed to this release.

#### What's Changed

##### Enhancements 🔥

-   Preserve pending commit message when closing/re-opening by [@&#8203;AzraelSec](https://github.com/AzraelSec) in jesseduffield/lazygit#4191
-   Swap position of checkout-commit and checkout-branch menu items by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4238
    -   In a previous release we had made it so that when you press space on a commit, the first option in the menu was to check out the corresponding branch, rather than the commit itself. We've made it so that now the first option is to check out the commit itself, for the sake of everybody's muscle memory.
-   Allow user to filter the files view to only show untracked files by [@&#8203;jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4226
-   Expose {{.SelectedCommitRange}} to custom commands by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4204
-   Show background fetch status in bottom line by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4215
-   Support copying tags to clipboard by [@&#8203;brunofjesus](https://github.com/brunofjesus) in jesseduffield/lazygit#4218
-   Add option to delete local and remote tag by [@&#8203;AnvarU](https://github.com/AnvarU) in jesseduffield/lazygit#4217
-   Show confirmation menu when trying to amend changes while there are conflicts by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4222
-   Improve error reporting on config migration by [@&#8203;kas2020-commits](https://github.com/kas2020-commits) in jesseduffield/lazygit#4210
-   Show files filter status by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4230
-   Improve contrast of highlighted search results by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4242

##### Fixes 🔧

-   Don't try killing processes if we already know the command finished by [@&#8203;brandondong](https://github.com/brandondong) in jesseduffield/lazygit#4231
    -   We believe this was causing all sorts of problems for windows users.
-   Add '--' to 'git rev-list' to disambiguate branch name from path by [@&#8203;efussi](https://github.com/efussi) in jesseduffield/lazygit#4185
-   Fix adding blank line at end of commit message by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4182
-   Fix checking out a different branch while pushing a branch for the first time by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4214
-   Fix tag being truncated when copying to clipboard by [@&#8203;brunofjesus](https://github.com/brunofjesus) in jesseduffield/lazygit#4232
-   Disable staging and unstaging lines or hunks when the diff context size is 0 by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4235
-   Fix incorrect stash diff after rename by [@&#8203;brandondong](https://github.com/brandondong) in jesseduffield/lazygit#4213
-   Fix possible crash when deleting a branch while filtering is active by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4195
-   Fix pasting multi-line text into commit message panel by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4234
-   fix: properly detect icon for BAZEL and WORKSPACE files by [@&#8203;PeterCardenas](https://github.com/PeterCardenas) in jesseduffield/lazygit#4252
-   Fix json schema for context of CustomCommand by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4255

##### Maintenance ⚙️

-   Bump go-deadlock version to fix crash with go 1.23 in debug mode by [@&#8203;ChrisMcD1](https://github.com/ChrisMcD1) in jesseduffield/lazygit#4248
-   Fix auto-release workflow by [@&#8203;jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4265

##### I18n 🌎

-   Update translations; includes a new Portuguese translation by [@&#8203;stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4250

#### New Contributors

-   [@&#8203;efussi](https://github.com/efussi) made their first contribution in jesseduffield/lazygit#4185
-   [@&#8203;brunofjesus](https://github.com/brunofjesus) made their first contribution in jesseduffield/lazygit#4218
-   [@&#8203;AnvarU](https://github.com/AnvarU) made their first contribution in jesseduffield/lazygit#4217
-   [@&#8203;kas2020-commits](https://github.com/kas2020-commits) made their first contribution in jesseduffield/lazygit#4210
-   [@&#8203;ChrisMcD1](https://github.com/ChrisMcD1) made their first contribution in jesseduffield/lazygit#4248
-   [@&#8203;PeterCardenas](https://github.com/PeterCardenas) made their first contribution in jesseduffield/lazygit#4252

**Full Changelog**: jesseduffield/lazygit@v0.45.2...v0.46.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xNzAuMSIsInVwZGF0ZWRJblZlciI6IjM5LjE3Ni40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
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.

Improve err reporting on failed config migration
3 participants