Skip to content

Commit 0fd498f

Browse files
committed
fix(docs): version path
1 parent ba62ef1 commit 0fd498f

File tree

3 files changed

+20
-22
lines changed

3 files changed

+20
-22
lines changed

README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55

66
# NPM-PUBLISH GRADLE PLUGIN
77

8-
> DISCLAIMER: If you still depend on the old LEGACY Kotlin/JS compiler, please stick
9-
> with [`npm-publish:2.1.x`](https://github.com/mpetuska/npm-publish/tree/2.1.x) version.
10-
> LEGACY backend support was dropped since `npm-publish:3.0.0`.
11-
128
Gradle plugin enabling NPM publishing (essentially `maven-publish` for NPM packages). Integrates seamlessly with
139
Kotlin/JS/MPP plugin if applied, providing auto configurations.
1410

npm-publish-docs/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ plugins {
55
mkdocs {
66
publish {
77
existingVersionsFile = "https://raw.githubusercontent.com/mpetuska/npm-publish/refs/heads/gh-pages/versions.json"
8-
versionTitle = "${project.version}".split(".").take(2).joinToString(".")
8+
docPath = "${project.version}".split(".").take(2).joinToString(".")
99
setVersionAliases("latest")
1010
rootRedirectTo = "latest"
1111
}

npm-publish-docs/src/docs/user-guide/configuration/registry.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ The registries can be accessed and configured from a `build.gradle.kts` file via
99

1010
```kotlin title="build.gradle.kts"
1111
npmPublish {
12-
registries {
13-
...
14-
}
12+
registries {
13+
...
14+
}
1515
}
1616
```
1717

@@ -23,14 +23,14 @@ detect and configure existing registries on subsequent invocations.
2323

2424
```kotlin title="build.gradle.kts"
2525
npmPublish {
26-
registries {
27-
npmjs {
28-
authToken.set("obfuscated")
29-
}
30-
github {
31-
authToken.set("obfuscated")
26+
registries {
27+
npmjs {
28+
authToken.set("obfuscated")
29+
}
30+
github {
31+
authToken.set("obfuscated")
32+
}
3233
}
33-
}
3434
}
3535
```
3636

@@ -59,9 +59,10 @@ npmPublish {
5959
| [`uri`](#uri) | | `npm.publish.registry.<name>.uri` | `NPM_PUBLISH_REGISTRY_<NAME>_URI` |
6060
| [`otp`](#otp) | | `npm.publish.registry.<name>.otp` | `NPM_PUBLISH_REGISTRY_<NAME>_OTP` |
6161
| [`authToken`](#authToken) | | `npm.publish.registry.<name>.authToken` | `NPM_PUBLISH_REGISTRY_<NAME>_AUTHTOKEN` |
62-
| [`auth`](#auth) | | `npm.publish.registry.<name>.auth` | `NPM_PUBLISH_REGISTRY_<NAME>_AUTH` |
63-
| [`username`](#username) | | `npm.publish.registry.<name>.username` | `NPM_PUBLISH_REGISTRY_<NAME>_USERNAME` |
64-
| [`password`](#password) | | `npm.publish.registry.<name>.password` | `NPM_PUBLISH_REGISTRY_<NAME>_PASSWORD` |
62+
| [`auth`](#auth) | | `npm.publish.registry.<name>.auth` | `NPM_PUBLISH_REGISTRY_<NAME>_AUTH` |
63+
| [`username`](#username) | | `npm.publish.registry.<name>.username` | `NPM_PUBLISH_REGISTRY_<NAME>_USERNAME` |
64+
| [`password`](#password) | | `npm.publish.registry.<name>.password` | `NPM_PUBLISH_REGISTRY_<NAME>_PASSWORD` |
65+
| [`npmrc`](#npmrc) | | `npm.publish.registry.<name>.npmrc` | `NPM_PUBLISH_REGISTRY_<NAME>_NPMRC` |
6566

6667
=== "Usage"
6768

@@ -80,6 +81,7 @@ npmPublish {
8081
// or
8182
username.set("obfuscated")
8283
password.set("obfuscated")
84+
npmrc.set(projectDir.resolve(".npmrc"))
8385
}
8486
}
8587
}
@@ -113,30 +115,30 @@ Auth token to use when authenticating with the registry.
113115
[More info](https://docs.npmjs.com/about-access-tokens)
114116

115117
!!! note
116-
Only one of `authToken`, `auth` or `username` + `password` should be provided.
118+
Only one of `authToken`, `auth` or `username` + `password` should be provided.
117119

118120
### `auth`
119121

120122
Base64 authentication string when authenticating with the registry.
121123

122124
!!! note
123-
Only one of `authToken`, `auth` or `username` + `password` should be provided.
125+
Only one of `authToken`, `auth` or `username` + `password` should be provided.
124126

125127
### `username`
126128

127129
Username to use when authenticating with the registry.
128130
Should always be specified together with a password.
129131

130132
!!! note
131-
Only one of `authToken`, `auth` or `username` + `password` should be provided.
133+
Only one of `authToken`, `auth` or `username` + `password` should be provided.
132134

133135
### `password`
134136

135137
Password to use when authenticating with the registry.
136138
Should always be specified together with a username.
137139

138140
!!! note
139-
Only one of `authToken`, `auth` or `username` + `password` should be provided.
141+
Only one of `authToken`, `auth` or `username` + `password` should be provided.
140142

141143
### `npmrc`
142144

0 commit comments

Comments
 (0)