Skip to content

📝 Documentation: Explain "INSERT_CODECOV_TOKEN_HERE" in hydration script #453

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.

Sign up for GitHub

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

Jump to bottom
Closed
2 tasks done
JoshuaKGoldberg opened this issue May 20, 2023 · 1 comment · Fixed by #636
Closed
2 tasks done

📝 Documentation: Explain "INSERT_CODECOV_TOKEN_HERE" in hydration script #453

JoshuaKGoldberg opened this issue May 20, 2023 · 1 comment · Fixed by #636
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

Overview

#441 added a hydration script that copies all of this template's goodness into an existing repository. Part of that includes copying over the top section of a README.md, including the Codecov badge:

https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/791332de33d8c89c62c689b9ed5ca7c10234fcb4/README.md#L13-L15

Note that that includes a token=.... Do we need that token? I don't remember why.

At any rate, I left that token as INSERT_CODECOV_TOKEN_HERE in the hydration template 😂:

https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/791332de33d8c89c62c689b9ed5ca7c10234fcb4/src/hydrate/writeReadme.ts#L84

One of the following things is true:

  • That token is unnecessary and should be removed
  • Documentation should be updated to mention where to get your token

...accepting PRs for whichever of those is right!

Additional Info

No response
@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this! labels May 20, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Aug 7, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Aug 7, 2023
@JoshuaKGoldberg
feat: remove codecov token from README.md (#636)
653cd64 
## PR Checklist

- [x] Addresses an existing open issue: fixes #453
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

I'm pretty sure the token is just for private repos. I don't mind
removing it for now. If someone has a private repo they can always add
it back in.
@github-actions
Copy link

github-actions bot commented Aug 7, 2023

🎉 This is included in version v1.28.46 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: remove codecov token from README.md JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg