Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

💡 Feature Request - Simplify workflow names in Accelerator #537

Closed
MilesCameron-DMs opened this issue May 22, 2023 · 3 comments
Closed

💡 Feature Request - Simplify workflow names in Accelerator #537

MilesCameron-DMs opened this issue May 22, 2023 · 3 comments
Assignees
@oZakari
Labels
Awaiting Release To Be Cut ✂️ This is fixed in the main branch but not in the latest release, will be fixed with next release cut
Milestone
v0.16.0

Comments

@MilesCameron-DMs
Copy link
Contributor

Describe the solution you'd like

At a glance, the workflows don't relate to what they are doing.

It would nice to see these renamed to make it easier to consume.

Something like this:

Old name New name
alz-bicep-1.yml alz-bicep-core.yml
alz-bicep-2.yml alz-bicep-policy-assignments.yml
alz-bicep-3.yml alz-bicep-sub-placement.yml
alz-bicep-4a.yml alz-bicep-hubnetwork.yml
alz-bicep-4b.yml alz-bicep-vwan.yml
alz-bicep-pr-1.yml alz-bicep-build-lint
alz-bicep-pr-2.yml alz-bicep-lint-code

Perhaps add to the documentation a diagram and a high level explanation? I am happy to create a draft on this?

Describe alternatives you've considered

None.

Additional context

Here are some draft diagrams i have put together and can simplify / tidy up / amend as suited:

Az Accelerator Workflows

Az Accelerator Workflows HLD
@ghost ghost added the Needs: Triage 🔍 Needs triaging by the team label May 22, 2023
@jtracey93 jtracey93 added Area: Accelerator and removed Needs: Triage 🔍 Needs triaging by the team labels May 22, 2023
@jtracey93 jtracey93 mentioned this issue May 23, 2023
Merged
10 tasks
@oZakari
Copy link
Contributor

oZakari commented May 24, 2023

Hi @MilesCameron-DMs, really like the diagrams! I will also get the file names and associated workflow names adjusted to reflect your recommendations as I agree that it would be helpful.

@MilesCameron-DMs
Copy link
Contributor Author

Thanks @oZakari - really glad I can help.

Happy to share or amend the diagrams for use. I am going to make some changes to the top one to make it easier to read.

@jtracey93 jtracey93 added this to the v0.16.0 milestone May 31, 2023
@oZakari oZakari mentioned this issue Jul 18, 2023
Merged
10 tasks
oZakari added a commit that referenced this issue Jul 21, 2023
@oZakari
PR for Feature #537: Simplify workflow names in Accelerator (#578)
e594962 
* Added release documentation and diagram

* Adjust Accelerator file names for clarity

* Merge branch 'main' of https://github.com/Azure/ALZ-Bicep into simplify-names

* Revert change for hub networking param file
@oZakari oZakari mentioned this issue Jul 21, 2023
Merged
10 tasks
@jtracey93 jtracey93 added the Awaiting Release To Be Cut ✂️ This is fixed in the main branch but not in the latest release, will be fixed with next release cut label Jul 25, 2023
@oZakari
Copy link
Contributor

oZakari commented Jul 25, 2023

Release v0.16.0 cut with file name changes.

@oZakari oZakari closed this as completed Jul 25, 2023
@oZakari oZakari mentioned this issue Jul 28, 2023
Closed
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@oZakari oZakari

Labels
Awaiting Release To Be Cut ✂️ This is fixed in the main branch but not in the latest release, will be fixed with next release cut
Projects
None yet
Milestone
v0.16.0
Development

No branches or pull requests
3 participants
@oZakari @jtracey93 @MilesCameron-DMs