Add automation scripts for workflow and linter templates

[jordanjones243]

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes: #32, #35, #36

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

• Add automation scripts that will automatically update templates for Github workflows and Linter configurations
• Add workflow that will create a surge demo for a component when a PR is created to merge into main or master
• Add automation to replace instances of abstractNodeVersion and branchName variables with a repo's respective node version and head branch name (main or master)

Additional Context

These scripts have been tested and validated as a POC in auro-combobox and can be verified by @jason-capsule42.

Type of change:

Please delete options that are not relevant.

• New capability
• Revision of an existing capability
• Infrastructure change (automation, etc.)
• Other (please elaborate)

Checklist:

• My update follows the CONTRIBUTING guidelines of this project
• I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

[blackfalcon]

So, the intent is to put things into this repo/npm and remove them from the Generator? Also, what is the process for running these scripts?

[jordanjones243]

So, the intent is to put things into this repo/npm and remove them from the Generator? Also, what is the process for running these scripts?

Yes, the intent is to remove workflow and configuration files from the Generator and move them into auro-library. A story for this can be created by @braven112 or @Patrick-Daly-AA.

The process for running/testing these scripts is to link auro-library into another component. To run the syncAllTemplates.mjs script, you will need to add a new node script into the linked component and point that to the syncAllTemplates.mjs file. You can individually run the workflow configurations by pointing to the syncAllTemplates.mjs file and adding a --github parameter after the path. The same can be done for the linter configurations by adding a --linters parameter.

To run the updated generateDocs.mjs script, point the build:docs script in the linked component to the the one that is now in auro-library, rather than the one currently being used in the linked component's repo.

[blackfalcon]

@jordanjones243

1. Engineers are responsible for creating issues with the necessary details for the work. @Patrick-Daly-AA and @braven112 really have the decision on when to do the work.
2. All the instructions you put in this comment, this should be put into the README or other resource. This isn't directly intuitive and no one is going to dig into these comments for these instructions.

[jordanjones243]

@jordanjones243

1. Engineers are responsible for creating issues with the necessary details for the work. @Patrick-Daly-AA and @braven112 really have the decision on when to do the work.
2. All the instructions you put in this comment, this should be put into the README or other resource. This isn't directly intuitive and no one is going to dig into these comments for these instructions.

I have created a story in WC-Generator to move the templates from the generator to auro-library:

• Move templates over into auro-library WC-Generator#423

I have also created a .md file containing instructions and code examples of how to run these scripts.

[jason-capsule42]

@jordanjones243

1. Engineers are responsible for creating issues with the necessary details for the work. @Patrick-Daly-AA and @braven112 really have the decision on when to do the work.
2. All the instructions you put in this comment, this should be put into the README or other resource. This isn't directly intuitive and no one is going to dig into these comments for these instructions.

I have created a story in WC-Generator to move the templates from the generator to auro-library:

• Move templates over into auro-library WC-Generator#423

I have also created a .md file containing instructions and code examples of how to run these scripts.

@blackfalcon @jordanjones243 I created a ticket that we should get prioritized soon for getting the individual documentation files rolled up into a more thorough readme and presented onto the docsite.

#37

I also added some additional context to this ticket in the generator for removing the files that we now have in the library saying that we need to first make sure the new component template is wired up with the automation to pull in the configuration files from the library.

[blackfalcon]

🎉 This PR is included in version 1.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀