assets/pi-bootstrap-usage.svg

<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="789px" preserveAspectRatio="none" style="width:613px;height:789px;background:#FFFFFF;" version="1.1" viewBox="0 0 613 789" width="613px" zoomAndPan="magnify"><defs><filter height="300%" id="f1e32r3i3essfu" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="18" lengthAdjust="spacing" textLength="192" x="209.5" y="26.708">pi-bootstrap - Usage</text><ellipse cx="301" cy="40.9531" fill="#000000" filter="url(#f1e32r3i3essfu)" rx="10" ry="10" style="stroke:none;stroke-width:1.0;"/><polygon fill="#FEFECE" filter="url(#f1e32r3i3essfu)" points="216.5,70.9531,385.5,70.9531,397.5,83.7578,385.5,96.5625,216.5,96.5625,204.5,83.7578,216.5,70.9531" style="stroke:#A80036;stroke-width:1.5;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="169" x="216.5" y="81.1636">Are you a developer creating</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="163" x="216.5" y="93.9683">templates for others to use?</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="21" x="183.5" y="81.1636">yes</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="14" x="397.5" y="81.1636">no</text><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="47.9375" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="178" x="105.5" y="106.5625"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="158" x="115.5" y="127.7012">Create a public repository</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="110" x="115.5" y="141.6699">from this template</text><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="47.9375" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="184" x="315.5" y="106.5625"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="164" x="325.5" y="127.7012">Create a private repository</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="110" x="325.5" y="141.6699">from this template</text><polygon fill="#FEFECE" filter="url(#f1e32r3i3essfu)" points="301,160.5,313,172.5,301,184.5,289,172.5,301,160.5" style="stroke:#A80036;stroke-width:1.5;"/><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="47.9375" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="215" x="193.5" y="248.5"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="22" x="203.5" y="269.6387">Edit</text><text fill="#000000" font-family="sans-serif" font-size="12" font-weight="bold" lengthAdjust="spacing" textLength="115" x="229.5" y="269.6387">bootstrap.Pifile</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="50" x="348.5" y="269.6387">to install</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="162" x="203.5" y="283.6074">custom packages and files</text><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="47.9375" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="148" x="227" y="316.4375"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="22" x="237" y="337.5762">Edit</text><text fill="#000000" font-family="sans-serif" font-size="12" font-weight="bold" lengthAdjust="spacing" textLength="30" x="263" y="337.5762">.env</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="59" x="297" y="337.5762">to include</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="128" x="237" y="351.5449">non-private variables</text><polygon fill="#FEFECE" filter="url(#f1e32r3i3essfu)" points="231.5,384.375,370.5,384.375,382.5,396.375,370.5,408.375,231.5,408.375,219.5,396.375,231.5,384.375" style="stroke:#A80036;stroke-width:1.5;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="139" x="231.5" y="400.1831">Are you building locally?</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="21" x="198.5" y="393.7808">yes</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="14" x="382.5" y="393.7808">no</text><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="47.9375" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="253" x="29" y="418.375"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="143" x="39" y="439.5137">Add private variables in</text><text fill="#000000" font-family="sans-serif" font-size="12" font-weight="bold" lengthAdjust="spacing" textLength="86" x="186" y="439.5137">secrets.env</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="59" x="39" y="453.4824">alongside</text><text fill="#000000" font-family="sans-serif" font-size="12" font-weight="bold" lengthAdjust="spacing" textLength="115" x="102" y="453.4824">bootstrap.Pifile</text><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="47.9375" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="289" x="11" y="486.3125"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="90" x="21" y="507.4512">Run build using</text><text fill="#000000" font-family="sans-serif" font-size="12" font-weight="bold" lengthAdjust="spacing" textLength="269" x="21" y="521.4199">sudo pimod/pimod.sh bootstrap.Pifile</text><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="47.9375" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="253" x="320" y="418.375"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="134" x="330" y="439.5137">Add repository secret</text><text fill="#000000" font-family="sans-serif" font-size="12" font-weight="bold" lengthAdjust="spacing" textLength="95" x="468" y="439.5137">SECRETS_ENV</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="189" x="330" y="453.4824">to include any private variables</text><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="47.9375" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="214" x="339.5" y="486.3125"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="113" x="349.5" y="507.4512">Run build using the</text><text fill="#000000" font-family="sans-serif" font-size="12" font-weight="bold" lengthAdjust="spacing" textLength="52" x="349.5" y="521.4199">manual</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="13" x="405.5" y="521.4199">or</text><text fill="#000000" font-family="sans-serif" font-size="12" font-weight="bold" lengthAdjust="spacing" textLength="55" x="422.5" y="521.4199">release</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="62" x="481.5" y="521.4199">workflows</text><polygon fill="#FEFECE" filter="url(#f1e32r3i3essfu)" points="301,540.25,313,552.25,301,564.25,289,552.25,301,540.25" style="stroke:#A80036;stroke-width:1.5;"/><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="47.9375" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="228" x="187" y="584.25"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="208" x="197" y="605.3887">Burn the image onto microSD card</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="129" x="197" y="619.3574">for booting or testing</text><polygon fill="#FEFECE" filter="url(#f1e32r3i3essfu)" points="301,204.5,313,216.5,301,228.5,289,216.5,301,204.5" style="stroke:#A80036;stroke-width:1.5;"/><polygon fill="#FEFECE" filter="url(#f1e32r3i3essfu)" points="262,652.1875,340,652.1875,352,664.1875,340,676.1875,262,676.1875,250,664.1875,262,652.1875" style="stroke:#A80036;stroke-width:1.5;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="78" x="262" y="667.9956">image works?</text><rect fill="#FEFECE" filter="url(#f1e32r3i3essfu)" height="33.9688" rx="12.5" ry="12.5" style="stroke:#A80036;stroke-width:1.5;" width="56" x="273" y="696.1875"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="36" x="283" y="717.3262">done!</text><ellipse cx="301" cy="761.1563" fill="#FFFFFF" filter="url(#f1e32r3i3essfu)" rx="11" ry="11" style="stroke:#000000;stroke-width:1.0;"/><ellipse cx="301" cy="761.1563" fill="#000000" rx="6" ry="6" style="stroke:#7F7F7F;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="204.5" x2="194.5" y1="83.7578" y2="83.7578"/><line style="stroke:#A80036;stroke-width:1.5;" x1="194.5" x2="194.5" y1="83.7578" y2="106.5625"/><polygon fill="#A80036" points="190.5,96.5625,194.5,106.5625,198.5,96.5625,194.5,100.5625" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="397.5" x2="407.5" y1="83.7578" y2="83.7578"/><line style="stroke:#A80036;stroke-width:1.5;" x1="407.5" x2="407.5" y1="83.7578" y2="106.5625"/><polygon fill="#A80036" points="403.5,96.5625,407.5,106.5625,411.5,96.5625,407.5,100.5625" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="194.5" x2="194.5" y1="154.5" y2="172.5"/><line style="stroke:#A80036;stroke-width:1.5;" x1="194.5" x2="289" y1="172.5" y2="172.5"/><polygon fill="#A80036" points="279,168.5,289,172.5,279,176.5,283,172.5" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="407.5" x2="407.5" y1="154.5" y2="172.5"/><line style="stroke:#A80036;stroke-width:1.5;" x1="407.5" x2="313" y1="172.5" y2="172.5"/><polygon fill="#A80036" points="323,168.5,313,172.5,323,176.5,319,172.5" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="301" x2="301" y1="50.9531" y2="70.9531"/><polygon fill="#A80036" points="297,60.9531,301,70.9531,305,60.9531,301,64.9531" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="301" x2="301" y1="296.4375" y2="316.4375"/><polygon fill="#A80036" points="297,306.4375,301,316.4375,305,306.4375,301,310.4375" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="155.5" x2="155.5" y1="466.3125" y2="486.3125"/><polygon fill="#A80036" points="151.5,476.3125,155.5,486.3125,159.5,476.3125,155.5,480.3125" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="446.5" x2="446.5" y1="466.3125" y2="486.3125"/><polygon fill="#A80036" points="442.5,476.3125,446.5,486.3125,450.5,476.3125,446.5,480.3125" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="219.5" x2="155.5" y1="396.375" y2="396.375"/><line style="stroke:#A80036;stroke-width:1.5;" x1="155.5" x2="155.5" y1="396.375" y2="418.375"/><polygon fill="#A80036" points="151.5,408.375,155.5,418.375,159.5,408.375,155.5,412.375" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="382.5" x2="446.5" y1="396.375" y2="396.375"/><line style="stroke:#A80036;stroke-width:1.5;" x1="446.5" x2="446.5" y1="396.375" y2="418.375"/><polygon fill="#A80036" points="442.5,408.375,446.5,418.375,450.5,408.375,446.5,412.375" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="155.5" x2="155.5" y1="534.25" y2="552.25"/><line style="stroke:#A80036;stroke-width:1.5;" x1="155.5" x2="289" y1="552.25" y2="552.25"/><polygon fill="#A80036" points="279,548.25,289,552.25,279,556.25,283,552.25" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="446.5" x2="446.5" y1="534.25" y2="552.25"/><line style="stroke:#A80036;stroke-width:1.5;" x1="446.5" x2="313" y1="552.25" y2="552.25"/><polygon fill="#A80036" points="323,548.25,313,552.25,323,556.25,319,552.25" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="301" x2="301" y1="364.375" y2="384.375"/><polygon fill="#A80036" points="297,374.375,301,384.375,305,374.375,301,378.375" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="301" x2="301" y1="564.25" y2="584.25"/><polygon fill="#A80036" points="297,574.25,301,584.25,305,574.25,301,578.25" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="301" x2="301" y1="228.5" y2="248.5"/><polygon fill="#A80036" points="297,238.5,301,248.5,305,238.5,301,242.5" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="352" x2="587" y1="664.1875" y2="664.1875"/><polygon fill="#A80036" points="583,450.3438,587,440.3438,591,450.3438,587,446.3438" style="stroke:#A80036;stroke-width:1.5;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="587" x2="587" y1="216.5" y2="664.1875"/><line style="stroke:#A80036;stroke-width:1.5;" x1="587" x2="313" y1="216.5" y2="216.5"/><polygon fill="#A80036" points="323,212.5,313,216.5,323,220.5,319,216.5" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="301" x2="301" y1="632.1875" y2="652.1875"/><polygon fill="#A80036" points="297,642.1875,301,652.1875,305,642.1875,301,646.1875" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="301" x2="301" y1="184.5" y2="204.5"/><polygon fill="#A80036" points="297,194.5,301,204.5,305,194.5,301,198.5" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="301" x2="301" y1="676.1875" y2="696.1875"/><polygon fill="#A80036" points="297,686.1875,301,696.1875,305,686.1875,301,690.1875" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.5;" x1="301" x2="301" y1="730.1563" y2="750.1563"/><polygon fill="#A80036" points="297,740.1563,301,750.1563,305,740.1563,301,744.1563" style="stroke:#A80036;stroke-width:1.0;"/><!--MD5=[ae73cd5adfeee3862ac504550b03b615]
@startuml
title pi-bootstrap - Usage


start

if (Are you a developer creating\ntemplates for others to use?) then (yes)
  :Create a public repository\nfrom this template;
else (no)
  :Create a private repository\nfrom this template;
endif

repeat

  :Edit **bootstrap.Pifile** to install\ncustom packages and files;
  
  :Edit **.env** to include\nnon-private variables;
  
  if (Are you building locally?) then (yes)
    :Add private variables in **secrets.env**\nalongside **bootstrap.Pifile**;
    :Run build using\n**sudo pimod/pimod.sh bootstrap.Pifile**;
  else (no)
    :Add repository secret **SECRETS_ENV**\nto include any private variables;
    :Run build using the\n**manual** or **release** workflows;
  endif
  
  :Burn the image onto microSD card\nfor booting or testing;

repeat while (image works?)

:done!;

stop
@enduml

PlantUML version 1.2021.10beta2(Unknown compile time)
(GPL source distribution)
Java Runtime: Java(TM) SE Runtime Environment
JVM: Java HotSpot(TM) 64-Bit Server VM
Default Encoding: UTF-8
Language: en
Country: US
--></g></svg>