-
Notifications
You must be signed in to change notification settings - Fork 14
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.
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
[PLAY-1391] Add Category to Playbook kit generator #3488
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…, updated status codes
jasperfurniss
previously approved these changes
Jun 27, 2024
jasperfurniss
previously approved these changes
Jun 28, 2024
nidaqg
previously approved these changes
Jul 3, 2024
nidaqg
approved these changes
Jul 5, 2024
3 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jul 11, 2024
**What does this PR do?** A clear and concise description with your runway ticket url. Fixes kit status that accidentally got put bsck into beta on [this PR](#3488)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Code Approved
Approved by a Playbook Admin
improvement
This is used when your PR contains library upgrades or doc/site improvements. (USED IN CHANGELOG))
milano
20 MAX - Deploy this PR to a review environment via Milano
Product Approved
pending technical review, OK to merge to master
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? A clear and concise description with your runway ticket url.
PLAY-1391 adds the capability to use a category flag when creating a new kit with the Playbook kit generator that allows for the newly generated kit to be sorted into one of the preexisting categories (aka submenus with in Components on the sidebar). This feature does not allow for the generation of new categories via this generator (creating new categories is a rare occurrence and should be done manually) and it is optional (when a kit is generated with a category flag, it will function like it is currently and just be appended to the bottom of the
menu.yml
).This ticket is a follow up following an initial investigation done during PLAY-1330 which fixed the Fix generator and updated its documentation. New information about the Category prop will be added to the Generating a Kit huddle doc once this is approved (the draft is here with doc changes pending approval).
Screenshots: Screenshots to visualize your addition/change
![uno code](https://private-user-images.githubusercontent.com/83474365/344259796-54ec61f8-2ef1-4cdc-ab61-316648f7febf.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA4Mjg3MTYsIm5iZiI6MTcyMDgyODQxNiwicGF0aCI6Ii84MzQ3NDM2NS8zNDQyNTk3OTYtNTRlYzYxZjgtMmVmMS00Y2RjLWFiNjEtMzE2NjQ4ZjdmZWJmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEyVDIzNTMzNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWM1NDkwYTQwZmIzYzUwZjRjNGU4OGM4ZDI2ZTJmMjc5NjE0ODM2ZWViOGJjNmQwOGJhNzAwNWYzZmU5NzczNGYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.rnS6xlxGiY4KzFEENAo9YRmJXGf--YnbNru4w4_fD0U)
![uno page](https://private-user-images.githubusercontent.com/83474365/344259807-5d294f89-6c4a-43f1-9d35-ed8a713bff85.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA4Mjg3MTYsIm5iZiI6MTcyMDgyODQxNiwicGF0aCI6Ii84MzQ3NDM2NS8zNDQyNTk4MDctNWQyOTRmODktNmM0YS00M2YxLTlkMzUtZWQ4YTcxM2JmZjg1LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEyVDIzNTMzNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTY3MzVmY2M1OGMzYzk3MTM1ZDJlYjAxZGFhNjQxYWZjZmFlMjI4YjQ5M2E3MDM1ODAwMzk3ODZmMDNmN2NhMjImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.z9HLJItUAh3LXdDiwKnCXBZXSQ5Anq4TeDLoVW7qjYc)
Example Uno: adding a new kit with a typo in the category, then successfully doing so once fixed
Example dos: adding a new kit with a category and a kit type
![dos code](https://private-user-images.githubusercontent.com/83474365/344260761-d6edc961-5c9a-4d84-9222-6c1752720f40.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA4Mjg3MTYsIm5iZiI6MTcyMDgyODQxNiwicGF0aCI6Ii84MzQ3NDM2NS8zNDQyNjA3NjEtZDZlZGM5NjEtNWM5YS00ZDg0LTkyMjItNmMxNzUyNzIwZjQwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEyVDIzNTMzNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTQ0NzkzZGNlMTJjM2IxZmJkZjJlYmJmOWQwMzc2ZTIwZWE1MjUzYzU1MWM3NjEzMmZjODY4Njc4NjFkZTliYWUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.Y5UIs4Oe0ppaxIEe5Pv6rXVkvf3RWbiqKSJBUUEOc6s)
![dos page](https://private-user-images.githubusercontent.com/83474365/344260781-9235c2a6-c29d-4dcb-9e69-dfc3c062ef9b.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA4Mjg3MTYsIm5iZiI6MTcyMDgyODQxNiwicGF0aCI6Ii84MzQ3NDM2NS8zNDQyNjA3ODEtOTIzNWMyYTYtYzI5ZC00ZGNiLTllNjktZGZjM2MwNjJlZjliLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEyVDIzNTMzNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWY0OTA5YTYxMGI4M2I1MGVlYWVjMzBmMDdlMTc0ZDdmNDdjMDdkYjU5ZDcyN2JmZDI4MjU3M2M3ZTBmMGQ4M2YmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.oJ2_qzSxZY-pSdlicWkf3vCIS3WS4uCwVNBQIqwbQKQ)
Example tres: adding a new kit without a category specified
![tres code](https://private-user-images.githubusercontent.com/83474365/344260845-14eea25c-bb5d-4b2c-8b8e-c19d715e3aea.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA4Mjg3MTYsIm5iZiI6MTcyMDgyODQxNiwicGF0aCI6Ii84MzQ3NDM2NS8zNDQyNjA4NDUtMTRlZWEyNWMtYmI1ZC00YjJjLThiOGUtYzE5ZDcxNWUzYWVhLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEyVDIzNTMzNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWMxZGQ5NmQyMzA1ZjE3YTIwMGE3OTg2Y2Q1N2NkNTZkMjU4M2MwZmNmMTY3ODVkYWE5ODczOTI3N2NhY2Y2ODAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.GI7lbLjcn40et8gcTPH_HoyYlEDFDnUWDZtg4qBXT7c)
![tres page](https://private-user-images.githubusercontent.com/83474365/344260878-7de0cd4d-2f81-48da-832e-5ab1556095ef.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA4Mjg3MTYsIm5iZiI6MTcyMDgyODQxNiwicGF0aCI6Ii84MzQ3NDM2NS8zNDQyNjA4NzgtN2RlMGNkNGQtMmY4MS00OGRhLTgzMmUtNWFiMTU1NjA5NWVmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEyVDIzNTMzNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTcxYzBmNjZmMjFkZjc4NTA3Yjg1MDE2MWFlNGNmN2M1NTQ5ZjZmMjFkMGMyNDM4MDI0NGVhMTdlODIzZGUxYTEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.U_IISs_pwOd8msPI2TtPjkL1xelg0q0uwi8tk93tk3Q)
Example quatro: adding a new kit with kit type, props, and category specified
![quatro code](https://private-user-images.githubusercontent.com/83474365/344261041-f2a5773a-cb78-4b76-8817-19f79c3e617e.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA4Mjg3MTYsIm5iZiI6MTcyMDgyODQxNiwicGF0aCI6Ii84MzQ3NDM2NS8zNDQyNjEwNDEtZjJhNTc3M2EtY2I3OC00Yjc2LTg4MTctMTlmNzljM2U2MTdlLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEyVDIzNTMzNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTZmMTI3NWZlMTRlOWJjMmFiY2I3OWNlMTNmMTNlZjVkMjU0OGE0ZTgwM2Q0ODc2ZTJkMzE4NzQ0ZmY2NDBlODEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.fLC6molwTBMYlu0qKxJxR--W3kyJlT3SlvbimQuq8aY)
![quatro page](https://private-user-images.githubusercontent.com/83474365/344261069-6a66a10c-8d85-4d99-b8a9-cb2a45777145.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA4Mjg3MTYsIm5iZiI6MTcyMDgyODQxNiwicGF0aCI6Ii84MzQ3NDM2NS8zNDQyNjEwNjktNmE2NmExMGMtOGQ4NS00ZDk5LWI4YTktY2IyYTQ1Nzc3MTQ1LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEyVDIzNTMzNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWJmMTU1NjYzY2FjZDA1ZWI2OTFiNTY3Yzc3Yjk0ZWIzOTJjZGNhZGU0MTJlNDc3NzI3NzA5YjkyNWRiODg2OTYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.hnVi204ARyBzTerTl3_G23xa2QOmXUK5QXZW8pdxvIw)
How to test? Steps to confirm the desired behavior:
menu.yml
file and visible on the PB website locally when you start the server and check localhost.menu.yml
like it did previously; try to mess up the category name (with a typo or a category that doesn't exist) and see the generator stall out.ALTERNATIVE:
Reference demo video in Runway ticket.
Checklist:
enhancement
,bug
,improvement
,new kit
,deprecated
, orbreaking
. See Changelog & Labels for details.milano
label to show I'm ready for a review.- [ ] TESTS I have added test coverage to my code.