grunt-nexus-artifact - npm Package Compare versions

Comparing version 0.3.6 to 0.3.7

package.json

 {
   "name": "grunt-nexus-artifact",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "A grunt plugin that helps with simple nexus artifacts",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -75,3 +75,2 @@ # grunt-nexus-artifact
 
-
 ### Options
@@ -195,2 +194,104 @@
 
+## Nexus verify task
+Run this task with the `grunt nexus:target:verify` command.
+This will pull down the last built artifact published to the nexus server.
+
+###Examples
+You can specify the version in the configuration. This is the preferred approach when the version is dynamic.
+```js
+nexus: {
+  client: {
+    url: 'http://nexus.google.com:8080',
+    repository: 'jslibraries',
+    verify: [
+      { 
+        id: 'com.google.js:jquery:tgz:',
+        version: '<%= buildVersion %>',
+        path: 'public/lib/jquery' 
+      }
+    ]
+  }
+}
+```
+
+You can also optionally append the version to the 'id' string.
+```js
+nexus: {
+  client: {
+    url: 'http://nexus.google.com:8080',
+    repository: 'jslibraries',
+    verify: [
+      { 
+        id: 'com.google.js:jquery:tgz:1.8.0',
+        path: 'public/lib/jquery' 
+      }
+    ]
+  }
+}
+```
+
+### Options
+
+#### url
+Type: `String`
+
+This defines the url of your nexus repository. This should be the base URL plus port. Ex: `http://your-nexus-repository:8080`
+
+#### repository
+Type: `String`
+
+This defines the name of the repository. _Since this task uses the REST API, the repository is not inferred_
+
+#### username
+Type: `String`
+
+This is an optional parameter that will be the nexus username - may not be needed for fetches
+
+#### password
+Type: `String`
+
+This is an optional parameter that will be the nexus password - may not be needed for fetches
+
+#### fetch
+Type: `Array{Object}`
+
+This defines an array of nexus artifacts to be retrieved from nexus. Each artifact has config options:
+
+##### group_id
+Type: `String`
+
+This defines the group_id of the artifact. Ex: `com.google.js`
+
+##### name
+Type: `String`
+
+This defines the name of the artifact. Ex: `jquery`
+
+##### ext
+Type: `String`
+
+Available extentions are `tgz`, `zip` and `jar`
+This defines the extension of the artifact. Ex: `tgz`
+
+##### version
+Type: `String`
+
+This defines the version of the artifact. Ex: `1.8.0`
+
+##### id
+Type: `String`
+
+This is a shorthand for `group_id`, `name`, `ext` and `version`. This defines the id string of the artifact in the following format:
+```{group_id}:{name}:{ext}:{version}```
+
+Ex:
+```
+com.google.js:jquery:tgz:1.8.0
+```
+
+##### path
+Type: `String`
+
+This defines the path where the artifact will be extracted to. Ex: `public/lib/jquery`
+
 # Release History
@@ -197,0 +298,0 @@ * 2013-08-08  v0.2.0  Added support for publishing artifacts

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19622

increased by31.51%

Number of package files

7

increased by16.67%

Number of lines in readme file

301

increased by50.5%

Worsened metrics

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes