Simplify documentation for Making your buildpack configurable (#768)

* Replace some `echo` instances with `cat` * Clean up formatting of the shell scripts Signed-off-by: linghengqian <linghengqian@outlook.com>
buildpacks · Sep 23, 2024 · 49d14eb · 49d14eb
1 parent 8d4d344
commit 49d14eb
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 9 deletions.
diff --git a/...for-buildpack-authors/tutorials/basic-buildpack/07_make-buildpack-configurable/index.html b/...for-buildpack-authors/tutorials/basic-buildpack/07_make-buildpack-configurable/index.html
@@ -913,15 +913,16 @@ <h2 id="select-nodejs-version">Select NodeJS version</h2>
 </span></span><span class="line"><span class="cl"><span class="k">fi</span>
 </span></span><span class="line"><span class="cl">
 </span></span><span class="line"><span class="cl"><span class="c1"># ======= ADDED =======</span>
-</span></span><span class="line"><span class="cl"><span class="nv">plan</span><span class="o">=</span><span class="si">${</span><span class="nv">CNB_BUILD_PLAN_PATH</span><span class="si">}</span>
 </span></span><span class="line"><span class="cl"><span class="nv">version</span><span class="o">=</span>3.1.3
 </span></span><span class="line"><span class="cl">
 </span></span><span class="line"><span class="cl"><span class="k">if</span> <span class="o">[[</span> -f .node-js-version <span class="o">]]</span><span class="p">;</span> <span class="k">then</span>
-</span></span><span class="line"><span class="cl"> <span class="nv">version</span><span class="o">=</span><span class="k">$(</span>cat .node-js-version <span class="p">|</span> tr -d <span class="s1">&#39;[:space:]&#39;</span><span class="k">)</span>
+</span></span><span class="line"><span class="cl"> <span class="nv">version</span><span class="o">=</span><span class="k">$(</span>&lt; .node-js-version tr -d <span class="s1">&#39;[:space:]&#39;</span><span class="k">)</span>
 </span></span><span class="line"><span class="cl"><span class="k">fi</span>
 </span></span><span class="line"><span class="cl">
-</span></span><span class="line"><span class="cl"><span class="nb">echo</span> <span class="s2">&#34;provides = [{ name = \&#34;node-js\&#34; }]&#34;</span> &gt; <span class="s2">&#34;</span><span class="nv">$plan</span><span class="s2">&#34;</span>
-</span></span><span class="line"><span class="cl"><span class="nb">echo</span> <span class="s2">&#34;requires = [{ name = \&#34;node-js\&#34;, metadata = { version = \&#34;</span><span class="nv">$version</span><span class="s2">\&#34; } }]&#34;</span> &gt;&gt; <span class="s2">&#34;</span><span class="nv">$plan</span><span class="s2">&#34;</span>
+</span></span><span class="line"><span class="cl">cat &gt; <span class="s2">&#34;</span><span class="si">${</span><span class="nv">CNB_BUILD_PLAN_PATH</span><span class="si">}</span><span class="s2">&#34;</span> <span class="s">&lt;&lt; EOL
+</span></span></span><span class="line"><span class="cl"><span class="s">provides = [{ name = &#34;node-js&#34; }]
+</span></span></span><span class="line"><span class="cl"><span class="s">requires = [{ name = &#34;node-js&#34;, metadata = { version = &#34;$version&#34; } }]
+</span></span></span><span class="line"><span class="cl"><span class="s">EOL</span>
 </span></span><span class="line"><span class="cl"><span class="c1"># ======= /ADDED =======</span>
 </span></span></code></pre></div><p>Then you will need to update your <code>build</code> script to look for the recorded NodeJS version in the build plan:</p>
 <p>Your <code>node-js-buildpack/bin/build</code> script should look like the following:</p>
@@ -944,16 +945,16 @@ <h2 id="select-nodejs-version">Select NodeJS version</h2>
 </span></span><span class="line"><span class="cl"><span class="nv">default_node_js_version</span><span class="o">=</span><span class="s2">&#34;18.18.1&#34;</span>
 </span></span><span class="line"><span class="cl"><span class="nv">node_js_version</span><span class="o">=</span><span class="k">$(</span>cat <span class="s2">&#34;</span><span class="nv">$plan</span><span class="s2">&#34;</span> <span class="p">|</span> yj -t <span class="p">|</span> jq -r <span class="s1">&#39;.entries[] | select(.name == &#34;node-js&#34;) | .metadata.version&#39;</span> <span class="o">||</span> <span class="nb">echo</span> <span class="si">${</span><span class="nv">default_node_js_version</span><span class="si">}</span><span class="k">)</span>
 </span></span><span class="line"><span class="cl"><span class="nv">node_js_url</span><span class="o">=</span>https://nodejs.org/dist/v<span class="si">${</span><span class="nv">node_js_version</span><span class="si">}</span>/node-v<span class="si">${</span><span class="nv">node_js_version</span><span class="si">}</span>-linux-x64.tar.xz
-</span></span><span class="line"><span class="cl"><span class="nv">remote_nodejs_version</span><span class="o">=</span><span class="k">$(</span>cat <span class="s2">&#34;</span><span class="si">${</span><span class="nv">CNB_LAYERS_DIR</span><span class="si">}</span><span class="s2">/node-js.toml&#34;</span> 2&gt; /dev/null <span class="p">|</span> yj -t <span class="p">|</span> jq -r .metadata.nodejs_version 2&gt;/dev/null <span class="o">||</span> <span class="nb">echo</span> <span class="s1">&#39;NOT FOUND&#39;</span><span class="k">)</span>
-</span></span><span class="line"><span class="cl"><span class="k">if</span> <span class="o">[[</span> <span class="s2">&#34;</span><span class="si">${</span><span class="nv">node_js_url</span><span class="si">}</span><span class="s2">&#34;</span> !<span class="o">=</span> *<span class="s2">&#34;</span><span class="si">${</span><span class="nv">remote_nodejs_version</span><span class="si">}</span><span class="s2">&#34;</span>* <span class="o">]]</span> <span class="p">;</span> <span class="k">then</span>
+</span></span><span class="line"><span class="cl"><span class="nv">remote_nodejs_version</span><span class="o">=</span><span class="k">$(</span>cat <span class="s2">&#34;</span><span class="si">${</span><span class="nv">CNB_LAYERS_DIR</span><span class="si">}</span><span class="s2">/node-js.toml&#34;</span> 2&gt;/dev/null <span class="p">|</span> yj -t <span class="p">|</span> jq -r .metadata.nodejs_version 2&gt;/dev/null <span class="o">||</span> <span class="nb">echo</span> <span class="s1">&#39;NOT FOUND&#39;</span><span class="k">)</span>
+</span></span><span class="line"><span class="cl"><span class="k">if</span> <span class="o">[[</span> <span class="s2">&#34;</span><span class="si">${</span><span class="nv">node_js_url</span><span class="si">}</span><span class="s2">&#34;</span> !<span class="o">=</span> *<span class="s2">&#34;</span><span class="si">${</span><span class="nv">remote_nodejs_version</span><span class="si">}</span><span class="s2">&#34;</span>* <span class="o">]]</span><span class="p">;</span> <span class="k">then</span>
 </span></span><span class="line"><span class="cl"> <span class="nb">echo</span> <span class="s2">&#34;-----&gt; Downloading and extracting NodeJS&#34;</span> <span class="si">${</span><span class="nv">node_js_version</span><span class="si">}</span>
 </span></span><span class="line"><span class="cl"> wget -q -O - <span class="s2">&#34;</span><span class="si">${</span><span class="nv">node_js_url</span><span class="si">}</span><span class="s2">&#34;</span> <span class="p">|</span> tar -xJf - --strip-components <span class="m">1</span> -C <span class="s2">&#34;</span><span class="si">${</span><span class="nv">node_js_layer</span><span class="si">}</span><span class="s2">&#34;</span>
 </span></span><span class="line"><span class="cl"><span class="k">else</span>
 </span></span><span class="line"><span class="cl"> <span class="nb">echo</span> <span class="s2">&#34;-----&gt; Reusing NodeJS&#34;</span>
 </span></span><span class="line"><span class="cl"><span class="k">fi</span>
 </span></span><span class="line"><span class="cl">
 </span></span><span class="line"><span class="cl"><span class="c1"># 4. MAKE node-js AVAILABLE DURING LAUNCH and CACHE the LAYER</span>
-</span></span><span class="line"><span class="cl"> cat &gt; <span class="s2">&#34;</span><span class="si">${</span><span class="nv">CNB_LAYERS_DIR</span><span class="si">}</span><span class="s2">/node-js.toml&#34;</span> <span class="s">&lt;&lt; EOL
+</span></span><span class="line"><span class="cl">cat &gt; <span class="s2">&#34;</span><span class="si">${</span><span class="nv">CNB_LAYERS_DIR</span><span class="si">}</span><span class="s2">/node-js.toml&#34;</span> <span class="s">&lt;&lt; EOL
 </span></span></span><span class="line"><span class="cl"><span class="s">[types]
 </span></span></span><span class="line"><span class="cl"><span class="s">cache = true
 </span></span></span><span class="line"><span class="cl"><span class="s">launch = true
@@ -963,7 +964,7 @@ <h2 id="select-nodejs-version">Select NodeJS version</h2>
 </span></span><span class="line"><span class="cl">
 </span></span><span class="line"><span class="cl"><span class="c1"># ========== ADDED ===========</span>
 </span></span><span class="line"><span class="cl"><span class="c1"># 5. SET DEFAULT START COMMAND</span>
-</span></span><span class="line"><span class="cl">cat &gt;&gt; <span class="s2">&#34;</span><span class="si">${</span><span class="nv">CNB_LAYERS_DIR</span><span class="si">}</span><span class="s2">/launch.toml&#34;</span> <span class="s">&lt;&lt; EOL
+</span></span><span class="line"><span class="cl">cat &gt; <span class="s2">&#34;</span><span class="si">${</span><span class="nv">CNB_LAYERS_DIR</span><span class="si">}</span><span class="s2">/launch.toml&#34;</span> <span class="s">&lt;&lt; EOL
 </span></span></span><span class="line"><span class="cl"><span class="s">[[processes]]
 </span></span></span><span class="line"><span class="cl"><span class="s">type = &#34;web&#34;
 </span></span></span><span class="line"><span class="cl"><span class="s">command = [&#34;node&#34;, &#34;app.js&#34;]

diff --git a/index.html b/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 
 <head>
- <meta name="generator" content="Hugo 0.134.2">
+ <meta name="generator" content="Hugo 0.134.3">