You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Internet Archive Typescript WebComponent Template
4
4
@@ -15,6 +15,8 @@ This is a base template for creating Typescript WebComponents. It is based off o
15
15
3.`README.md` (this file). Update the readme in general, but also the badge URLs
16
16
4.`package.json` Update the name and description
17
17
5. Rename the `your-webcomponent.ts` and its associated `.test` file
18
+
6. Enable `Codecov` and `renovate` in the GitHub Apps section if not already enabled (be sure not to enable `pre-commit`)
19
+
7. Set up a Codecov token (see [Codecov Setup](#codecov-setup))
18
20
19
21
## Local Demo with `web-dev-server`
20
22
```bash
@@ -85,10 +87,24 @@ For most of the tools, the configuration is in the `package.json` to reduce the
85
87
86
88
If you customize the configuration a lot, you can consider moving them to individual files.
87
89
88
-
### Add Codecov
89
-
- after forking, add your repo to the authorized codecov list: `https://github.com/organizations/internetarchive/settings/installations/1268216`
90
-
- then, go to the badge maker page for your repo: `https://app.codecov.io/gh/internetarchive/<repo-name>/settings/badge`
91
-
- copy link & paste into top of README.md
90
+
### Codecov setup
91
+
**Finding your token**
92
+
- Log in at https://codecov.io/ with your GitHub account
93
+
- Switch from your personal organization to `internetarchive` if needed, by toggling at the top of the screen or visiting https://app.codecov.io/gh/internetarchive directly
94
+
- Find your repository and hit the `Configure` button or visit `https://app.codecov.io/gh/internetarchive/YOUR-REPO-NAME/config`
95
+
- Go the `General` tab and find the `Tokens` section
96
+
- Copy everything after `CODECOV_TOKEN=`
97
+
98
+
**Adding your token**
99
+
- Return to your repository and go to `Settings` > `Secrets and variables` (under `Security`) > `Actions`
100
+
- Select `New repository secret`
101
+
- Name your secret `CODECOV_TOKEN` and paste in the token you just copied
102
+
- Select `Add Secret`
103
+
104
+
**Adding your badge**
105
+
- Back in `Configuration` in Codecov, go to the `Badges & Graphs` section
106
+
- Copy the Markdown version of the badge
107
+
- Delete the current Codecov badge at the top of this README and replace it with your new badge
92
108
93
109
## Steps to setup `gh-pages` static site generator
0 commit comments