Overview/Summary

Created GH Actions Workflow which generates Markdown from Bicep files leveraging PSDocs for Azure.

In order, this will:

Workflow triggered from push on 'main' with Bicep files as path as condition
Check out the repository
Perform a Bicep build on each of the modules to create ARM Templates (JSON)
Add two additional key value pairs to the templates. Name, which corresponds to the name of the Bicep file. Description, brings in an 'Up a level' hyperlink.
Generates Markdown from the templates
Removes the ARM Template files, leaving just the Bicep and the generated Markdown
Commits and pushes the markdown if any changes are needed
A hyperlink to the generated markdown files has already been inserted and replaces the parameters table in each of the static README.md's for standardisation across the board.

This PR fixes/adds/changes/removes

Adds GitHub Workflow for MD Generation for modules
Removes parameter tables from static readme's, link to new generated MD inserted

Breaking Changes

N/A

Testing Evidence

As part of this Pull Request I have

[X] Read the Contribution Guide and ensured this PR is compliant with the guide
[X] Ensured the resource API versions in .bicep file/s I am adding/editing are using the latest API version possible
[X] Checked for duplicate Pull Requests
[X] Associated it with relevant GitHub Issues
[X] (ALZ Bicep Core Team Only) Associated it with relevant ADO Items
[X] Ensured my code/branch is up-to-date with the latest changes in the main branch
[X] Performed testing and provided evidence.
[X] Updated one or more of the following tests (if required)
[X] Updated relevant and associated documentation (e.g. Contribution Guide, Module READMEs, Wiki Docs etc.)
[X] If relevant, created or updated Code Tours here

Aug 19 '22 10:08 4ppli3d

Great work, @JamJarchitect

As discussed on our call a few minutes ago, there are some additional test cases that we need to think about here.

These are all based on the fact that I believe the GitHub action will not run successfully in the main Azure/alz-bicep repo due to the branch protection policies that are in place upon the main branch.

Therefore, can I ask that you have a think and create some tests and test it out yourself? For handling. Updates into a pull request or the branch that is associated from an external users pull request into the main branch on perhaps a fork for testing (would be azure/alz-bicep main in reality).

If we can make the workflow update the branch that the pull request has originated from. Then I think this is the best option.

I have placed the do not merge label on this PR and will await your updates on this topic.

👍👍

Aug 31 '22 11:08 jtracey93

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment.

Sep 07 '22 12:09 ghost

This is still active

Sep 07 '22 12:09 jtracey93

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment.

Sep 14 '22 15:09 ghost

Still active

Sep 14 '22 15:09 jtracey93

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment.

Sep 21 '22 18:09 ghost

still active

Sep 21 '22 18:09 jtracey93

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment.

Sep 28 '22 21:09 ghost

@JamJarchitect can we fix the merge conflicts

Nov 03 '22 19:11 jtracey93

/azp run e2e

Nov 07 '22 13:11 4ppli3d