Components in a Folder

It can be very useful to work with components which are located in a specific folder, only. For example an API, where an API component (web-service) and two processes implementing the API end-points are located in the same folder.

/#Examples/95 - Documentation Examples/#APIServices/GPR - GoodPractices

Create documentation

Create documentation for all deployable components in the specified folder, and write the output to GoodPractices.

.\bc comp doc /deployableOnly /f "*GPR - GoodPractices*" /o GoodPractices 

You will find the rendered documentation in the specified output folder GoodPractices/Doc:

The documentation is interactive (see Documentation Links).

Get deployment overview

Get all deployed components which are located in the specified folder and render the deployedPackage.csv to see which version was deployed to which environment.

Write the output to GoodPractices.

.\bc deploy get /f "*GPR - GoodPractices*" /t deployedPackages.csv /o GoodPractices

Depending on the CSV Viewer you chose (VS Code Extension: Excel Viewer or Rainbow CSV), you will probably get something like this:

Arguments explained

• /f *{folderName}* The folder-name with wild-cards as the component source. The wildcarded name is used to lookup the folder full path.

• /o The directory where all outputs will be written to, relative to the workspace directory! It is recommended to use out\{folderName}

• /t compList.CSV A predefined template to render the component output.

  

Observations