@travetto/pack 8.0.0-alpha.20 → 8.0.0-alpha.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -12
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -28,11 +28,11 @@ $ trv pack --help
28
28
 
29
29
  Usage: pack [options] [args...:string]
30
30
 
31
- Build a standard module package artifact.
31
+ Description:
32
+ Build a standard module package artifact.
32
33
 
33
- This base command produces the default packaged output and serves as the
34
- common entry point for module packaging workflows.
35
- Example Usage:
34
+ This base command produces the default packaged output and serves as the
35
+ common entry point for module packaging workflows.
36
36
 
37
37
  Options:
38
38
  -b, --buildDir <string> Workspace for building (default: "/tmp/<temp-folder>")
@@ -52,6 +52,8 @@ Options:
52
52
  -np, --npm-package <string> External NPM Packages (default: [])
53
53
  -m, --module <module> Module to run for
54
54
  --help display help for command
55
+
56
+ Examples:
55
57
  ```
56
58
 
57
59
  This command line operation will compile your project, and produce a ready to use workspace as a deliverable. Additionally, you can pass in a file to the `eject-file` flag that will allow for a script to be produced (base on the host operating system).
@@ -100,11 +102,11 @@ $ trv pack:zip --help
100
102
 
101
103
  Usage: pack:zip [options] [args...:string]
102
104
 
103
- Build a deployable zip artifact using the standard pack pipeline.
105
+ Description:
106
+ Build a deployable zip artifact using the standard pack pipeline.
104
107
 
105
- This command runs base packing operations and then compresses the generated
106
- output into a single archive file.
107
- Example Usage:
108
+ This command runs base packing operations and then compresses the generated
109
+ output into a single archive file.
108
110
 
109
111
  Options:
110
112
  -b, --buildDir <string> Workspace for building (default: "/tmp/<temp-folder>")
@@ -124,6 +126,8 @@ Options:
124
126
  -np, --npm-package <string> External NPM Packages (default: [])
125
127
  -m, --module <module> Module to run for
126
128
  --help display help for command
129
+
130
+ Examples:
127
131
  ```
128
132
 
129
133
  ## CLI - pack:docker
@@ -135,11 +139,11 @@ $ trv pack:docker --help
135
139
 
136
140
  Usage: pack:docker [options] [args...:string]
137
141
 
138
- Build container-ready artifacts and optionally publish Docker images.
142
+ Description:
143
+ Build container-ready artifacts and optionally publish Docker images.
139
144
 
140
- Extends the core pack pipeline with Dockerfile generation and image build/
141
- push operations, including runtime user and registry customization.
142
- Example Usage:
145
+ Extends the core pack pipeline with Dockerfile generation and image build/
146
+ push operations, including runtime user and registry customization.
143
147
 
144
148
  Options:
145
149
  -b, --buildDir <string> Workspace for building (default: "/tmp/<temp-folder>")
@@ -170,6 +174,8 @@ Options:
170
174
  -db, --docker-build-platform <string> Docker Build Platform
171
175
  -dr, --docker-registry <string> Docker Registry
172
176
  --help display help for command
177
+
178
+ Examples:
173
179
  ```
174
180
 
175
181
  The additional flags provided are allow for specifying the base image, the final docker image name (and tags), and which registry to push to (if any). Additionally, there are flags for exposing which ports the image should expect to open as well. When using the `--eject-file` flag, the output script will produce the entire Dockerfile output inline, so that it can be easily modified as needed.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@travetto/pack",
3
- "version": "8.0.0-alpha.20",
3
+ "version": "8.0.0-alpha.21",
4
4
  "type": "module",
5
5
  "description": "Code packing utilities",
6
6
  "keywords": [
@@ -30,12 +30,12 @@
30
30
  "@rollup/plugin-json": "^6.1.0",
31
31
  "@rollup/plugin-node-resolve": "^16.0.3",
32
32
  "@rollup/plugin-terser": "^1.0.0",
33
- "@travetto/runtime": "^8.0.0-alpha.17",
34
- "@travetto/terminal": "^8.0.0-alpha.17",
33
+ "@travetto/runtime": "^8.0.0-alpha.18",
34
+ "@travetto/terminal": "^8.0.0-alpha.18",
35
35
  "rollup": "^4.61.1"
36
36
  },
37
37
  "peerDependencies": {
38
- "@travetto/cli": "^8.0.0-alpha.23"
38
+ "@travetto/cli": "^8.0.0-alpha.25"
39
39
  },
40
40
  "peerDependenciesMeta": {
41
41
  "@travetto/cli": {