Skip to content

Commit

Permalink
Document version
Browse files Browse the repository at this point in the history
  • Loading branch information
colincasey committed Apr 12, 2024
1 parent b95d4c9 commit ac1a471
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 3 deletions.
1 change: 1 addition & 0 deletions api/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ docs/*.md

# subsequent PRs will un-ignore areas that are under review until
# all docs are complete and we can drop this ignore file entirely
!docs/tough-cookie.version.md
!docs/tough-cookie.parsedate.md
!docs/tough-cookie.formatdate.md
!docs/tough-cookie.domainmatch.md
Expand Down
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [version](./tough-cookie.version.md)

## version variable

The version of `tough-cookie`

**Signature:**

```typescript
version = "5.0.0-rc.1"
```
2 changes: 1 addition & 1 deletion api/tough-cookie.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ export class Store {
updateCookie(oldCookie: Cookie, newCookie: Cookie, callback: ErrorCallback): void;
}

// @public (undocumented)
// @public
export const version = "5.0.0-rc.1";

// (No @packageDocumentation comment for this package)
Expand Down
5 changes: 4 additions & 1 deletion lib/version.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Generated by genversion.
/**
* The version of `tough-cookie`
* @public
*/
export const version = '5.0.0-rc.1'
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"api:extract": "api-extractor run --verbose",
"build": "npm run clean && tsc",
"clean": "rm -rf dist",
"version": "genversion --es6 lib/version.ts && git add lib/version.ts",
"version": "genversion --template version-template.ejs --force lib/version.ts && git add lib/version.ts",
"test": "npm run test:ts && npm run test:legacy",
"test:ts": "jest",
"test:legacy": "npm run build -- --declaration false && ./test/scripts/vows.js test/*_test.js",
Expand Down
5 changes: 5 additions & 0 deletions version-template.ejs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/**
* The version of `tough-cookie`
* @public
*/
export const version = '<%= pkg.version %>'

0 comments on commit ac1a471

Please sign in to comment.