Skip to content

Commit 7369f7f

Browse files
committed
Fix vale issues
1 parent 004c6eb commit 7369f7f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

fern/products/sdks/overview/typescript/publishing-to-npm.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,10 @@ groups:
106106
107107
## Configure authentication
108108
109-
Choose how you want to authenticate with npmjs when publishing. **OIDC is strongly recommended** for security.
109+
Choose how you want to authenticate with npmjs when publishing. **OpenID Connect (OIDC) is strongly recommended** for security.
110110
111111
<Note>
112-
**Starting in early 2025**, npmjs.org is deprecating long-lived authentication tokens for publishing from CI/CD workflows. We recommend using OIDC-based authentication.
112+
**Starting in early 2025**, npmjs.org is deprecating long-lived authentication tokens for publishing from CI/CD workflows. OIDC-based authentication is recommended.
113113
</Note>
114114
115115
<AccordionGroup>
@@ -193,7 +193,7 @@ Common causes:
193193

194194
**Private repository limitations**
195195

196-
Provenance attestations are not generated for packages published from private repositories, even when using trusted publishing. This is a [known limitation](https://github.blog/changelog/2023-07-25-publishing-with-npm-provenance-from-private-source-repositories-is-no-longer-supported/).
196+
Provenance attestations aren't generated for packages published from private repositories, even when using trusted publishing. This is a [known limitation](https://github.blog/changelog/2023-07-25-publishing-with-npm-provenance-from-private-source-repositories-is-no-longer-supported/).
197197

198198
</Accordion>
199199

@@ -202,7 +202,7 @@ Provenance attestations are not generated for packages published from private re
202202
<Accordion title="Token-based authentication (Legacy)">
203203

204204
<Warning>
205-
**This method is being deprecated by npmjs.org in early 2025.** We strongly recommend using OIDC-based authentication instead. Long-lived authentication tokens can be accidentally exposed in logs, compromised, and are difficult to manage and rotate.
205+
**This method is being deprecated by npmjs.org in early 2025.** OIDC-based authentication is strongly recommended instead. Long-lived authentication tokens can be exposed in logs, compromised, and are difficult to manage and rotate.
206206
</Warning>
207207

208208
<Steps>
@@ -261,7 +261,7 @@ groups:
261261

262262
Your SDK will automatically be published to npmjs when you create a GitHub release with a version tag:
263263

264-
1. Create a GitHub release with a version tag (e.g., `v1.0.0`)
264+
1. Create a GitHub release with a version tag (for example, `v1.0.0`)
265265
1. The CI workflow will run automatically and publish to npm
266266
1. View your package on npmjs.com to confirm the new version
267267

@@ -308,13 +308,13 @@ If you're currently using token-based authentication and need to migrate to OIDC
308308

309309
### Why migrate to OIDC
310310

311-
npm is implementing trusted publishing to eliminate security risks associated with long-lived tokens, which can be:
311+
npmjs is implementing trusted publishing to remove security risks associated with long-lived tokens, which can be:
312312

313-
- Accidentally exposed in logs or configuration files
313+
- Exposed in logs or configuration files
314314
- Compromised and used persistently until manually revoked
315315
- Difficult to manage and rotate
316316

317-
OIDC-based publishing uses short-lived, cryptographically-signed tokens that are specific to your workflow and cannot be extracted or reused.
317+
OIDC-based publishing uses short-lived, cryptographically signed tokens that are specific to your workflow and can't be extracted or reused.
318318

319319
### Prerequisites
320320

@@ -405,10 +405,10 @@ This is the easiest path if you can upgrade to version 3.12.0 or later of the Ty
405405

406406
<Accordion title="Path 2: Manual CI workflow update">
407407

408-
Use this path if you cannot upgrade the generator or have customized your CI workflow.
408+
Use this path if you can't upgrade the generator or have customized your CI workflow.
409409

410410
**When to use this path:**
411-
- You cannot upgrade due to breaking changes or bugs
411+
- You can't upgrade due to breaking changes or bugs
412412
- You've customized your CI workflow and added it to `.fernignore`
413413
- Path 1 didn't update your workflow file
414414

@@ -506,7 +506,7 @@ Use this path if you cannot upgrade the generator or have customized your CI wor
506506

507507
After completing either migration path:
508508

509-
1. **Trigger a workflow run** by creating a GitHub release with an alpha tag (e.g., `v1.0.0-alpha`)
509+
1. **Trigger a workflow run** by creating a GitHub release with an alpha tag (for example, `v1.0.0-alpha`)
510510
2. **Check the workflow logs** to verify the publish step succeeds
511511
3. **Verify provenance** by visiting your package on [npmjs.com](https://npmjs.com) - you should see a provenance badge
512512

0 commit comments

Comments
 (0)