Skip to content

Conversation

adripo
Copy link
Contributor

@adripo adripo commented Apr 19, 2025

This PR focuses on renaming the missing parts of the application from Hoarder to Karakeep across the codebase, configurations, and related files. Below is a summary of the changes and notes for review:

Summary of Changes:

  1. File Renaming:

    • Renamed multiple files to reflect the new application name.
    • Please verify if any file renaming needs to be reverted.
  2. Configuration Updates:

    • Updated important configurations to reflect the new name.
    • Specifically, check name in package.json and if changes in GitHub workflows are necessary or should be reverted.
  3. Firefox Add-on Link:

    • Updated the Firefox add-on link to use "karakeep" assuming migration is in progress. Please confirm if this is correct, the old url is not working anymore.
  4. Mobile App Changes:

    • NO UPDATE on this one. I can change the slug, package, and bundleIdentifier in app.json to reflect the new name if possible.
  5. Weblate Migration:

  6. Pikapods Configuration:

    • Pikapods configuration needs to be updated to reflect the new app name. This is not addressed in this PR but should be handled separately.

Notes for Reviewers:

  • I manually checked each modification to avoid removing references to "hoarder" that need to remain. However, please double-check for any unintended changes.
  • Let me know if any of the changes (e.g., GitHub workflows) should be reverted.
  • Additional steps like Weblate migration and Pikapods updates are outside the scope of this PR but are noted for follow-up.

Copy link
Collaborator

@MohamedBassem MohamedBassem left a comment

Choose a reason for hiding this comment

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

Wow! Thank you so much for this, I have been procrastinating in doing this for a while now! I also appreciate the thoroughness in the PR description.

  1. The new mozilla link works now.
  2. As for pikapods, I'll have to reach out to the folks there first. Let's keep the old link for now.
  3. Weblate I'll do after merging the PR and I can update the link manually, thanks for pointing it out.

I've left a couple of comments about things that should be reverted, but nothing major. Thanks a lot!

I'm planning to do a release tomorrow or on Monday, let's try to get this PR before that then!

@@ -1,6 +1,6 @@
import { z } from "zod";

export const USER_LOCAL_SETTINGS_COOKIE_NAME = "hoarder-user-local-settings";
export const USER_LOCAL_SETTINGS_COOKIE_NAME = "karakeep-user-local-settings";
Copy link
Collaborator

Choose a reason for hiding this comment

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

This will break people's local settings (e.g. layouts, etc). I'd keep it as hoarder for now until there's a strong reason to change it.

Comment on lines 17 to 18
Choose _Karakeep_ from their [list of apps](https://www.pikapods.com/apps) or use this [direct link](https://www.pikapods.com/pods?run=karakeep). This will either
open a new dialog to add a new _Karakeep_ pod or ask you to log in.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Pikapod still haven't updated their app's name. Let's revert the link for now.

- image: ghcr.io/hoarder-app/hoarder-web:${HOARDER_VERSION:-release}
+ image: ghcr.io/hoarder-app/hoarder:${HOARDER_VERSION:-release}
- image: ghcr.io/hoarder-app/hoarder-web:${KARAKEEP_VERSION:-release}
+ image: ghcr.io/hoarder-app/hoarder:${KARAKEEP_VERSION:-release}
Copy link
Collaborator

Choose a reason for hiding this comment

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

It should be ok to update the image link here to karakeep.

@@ -1,11 +1,11 @@
import createClient from "openapi-fetch";

import type { components, paths } from "./hoarder-api.d.ts";
import type { components, paths } from "./karakeep-api.js";
Copy link
Collaborator

Choose a reason for hiding this comment

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

shouldn't this be karakeep-api.d.ts instead?


/**
* @deprecated Use createKarakeepClient instead.
*/
export const createHoarderClient = createClient<paths>;
export const createKarakeepClient = createClient<paths>;
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should remain as is for backward compatibility. createKarakeepClient is already defined underneath it and this API is already marked as deprecated.

@MohamedBassem MohamedBassem merged commit 4296e7f into karakeep-app:main Apr 21, 2025
5 checks passed
@MohamedBassem
Copy link
Collaborator

Thanks a lot @adripo!

@adripo
Copy link
Contributor Author

adripo commented Apr 22, 2025

Hi @MohamedBassem sorry for the delay. I was away in the last few days. I see you already solved the pending modifications and merged the PR. Let me know if you need any more help on this. Thanks!

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.

2 participants