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

🐛 Bug: Repo API failure: "description control characters are not allowed" #2046

Closed
3 tasks done
JoshuaKGoldberg opened this issue Mar 27, 2025 · 1 comment · Fixed by #2047
Closed
3 tasks done
Assignees
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Expected

Running npx create-typescript-app should work on repos with long descriptions.

Actual

Running on https://github.com/JoshuaKGoldberg/debug-for-file/tree/017f4f35803c2fb970acf6236b110ed051fde005, after putting a console.log({ description }) in blockRepositorySettings > produce:

joshgoldberg ~/repos/debug-for-file $ npx create-typescript-app --add-cta-transitions
┌  ✨ [email protected] ✨
│
●  Learn more on:
│    https://github.com/JoshuaKGoldberg/create-typescript-app
│
◇  Running with mode --transition using the config file:
│    create-typescript-app
│
{ description: '' }
{ description: '' }
{ description: '' }
│
◇  Detected --preset everything from existing files on disk.
│  
◇  Inferred options from existing repository
│
{
  description: "debug() wrapper that creates a string based on your file's path within the\n" +
    'package. 🧶'
}
◇  Ran create-typescript-app
│
■  The PATCH /repos/{owner}/{repo} request failed. You should re-run it and fix its complaints.
│  HttpError: Validation Failed: {"resource":"Repository","code":"custom","field":"description","message":"description control characters are not allowed"} - https://docs.github.com/rest/repos/repos#update-a-repository
│      at fetchWrapper (file:///Users/josh/repos/debug-for-file/node_modules/.pnpm/@[email protected]/node_modules/@octokit/request/dist-bundle/index.js:122:11)
│      at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
│      at async requestWithGraphqlErrorHandling (file:///Users/josh/repos/debug-for-file/node_modules/.pnpm/@[email protected]_@[email protected]/node_modules/@octokit/plugin-retry/dist-bundle/index.js:36:20)
│      at async Job.doExecute (/Users/josh/repos/debug-for-file/node_modules/.pnpm/[email protected]/node_modules/bottleneck/light.js:405:18)
│
└  Done. Enjoy your updated repository! 💝

Looks like a \n is getting added in.

Additional Info

🎁

@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :( labels Mar 27, 2025
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Mar 27, 2025
Copy link

🎉 This is included in version v2.16.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant