search

jsonresume / jsonresume.org

The mono repo that builds the homepage, utils, ui components, registry and anything else
https://jsonresume.org
66 stars 17 forks source link

fix: add a link to a github issue when themes are missing #37

Closed thomasdavis closed 8 months ago

thomasdavis commented 8 months ago

Fix #38

Summary by CodeRabbit

vercel[bot] commented 8 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
jsonresume-org-homepage ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 29, 2023 9:50am
jsonresume-org-registry ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 29, 2023 9:50am
coderabbitai[bot] commented 8 months ago

Walkthrough

The recent updates focus on improving error handling within an API. Error messages have been clarified, and HTTP status codes adjusted to better reflect the nature of the errors. A specific case for a missing theme has been addressed, providing users with a helpful link to report or request themes on GitHub.

Changes

File Path Change Summary
.../[payload].js Corrected error message wording, added custom error message for "theme-missing" with a GitHub issue link, and updated HTTP status codes for various errors.
.../formatters/template.js Implemented error handling for missing theme renderer.

🐇✨ To the code we hop and leap, Errors caught, no more we weep. With messages clear and guide in hand, Our code now speaks, as we had planned. 🌟📜

Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - If you reply to a *review comment* from CodeRabbit, the bot will automatically respond. - To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment - Note: Review comments are made on code diffs or files, not on the PR overview. - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Note: For conversation with the bot, please use the review comments on code diffs or files. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json`
thomasdavis commented 8 months ago

@levino approval on this one is kinda of urgent

levino commented 8 months ago

Please see https://github.com/jsonresume/jsonresume.org/issues/38#issuecomment-1831578943 If you get impatient, let me know and I will approve anyhow.

levino commented 8 months ago

@thomasdavis You can now "override" the branch protection rules and merge as you please. There should be a checkbox with a red warning text just above the "merge button". This is so you do not become blocked if I am absent etc. I suggest to still only use it when it is really necessary ("emergency").

levino commented 8 months ago

I would also add a test to try to open the site with a non-working theme and see that it returns an error code and check that the message contains expected strings (like "github issue" or something).

thomasdavis commented 8 months ago

@levino good feedback. just merging for now so i can collect the errors of the themes that are missing. but will add the test, and move to a theme request template later today