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.

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

feat(rush-lib): setup Rush Custom Tips #4208

Merged
merged 38 commits into from
Aug 12, 2023

Conversation

theJiawen
Copy link
Contributor

This is a prototype PR for the design proposal #4207 . Any comments are welcomed.

@theJiawen
Copy link
Contributor Author

@microsoft-github-policy-service agree

libraries/rush-lib/src/api/CustomTips.ts Outdated Show resolved Hide resolved
libraries/rush-lib/src/api/CustomTips.ts Outdated Show resolved Hide resolved
libraries/rush-lib/src/api/CustomTips.ts Outdated Show resolved Hide resolved
Consider the case when the config file not exist.
common/reviews/api/rush-lib.api.md Outdated Show resolved Hide resolved
libraries/rush-lib/src/api/CustomTipsConfiguration.ts Outdated Show resolved Hide resolved
libraries/rush-lib/src/api/CustomTipsConfiguration.ts Outdated Show resolved Hide resolved
libraries/rush-lib/src/api/CustomTipsConfiguration.ts Outdated Show resolved Hide resolved
rush-custom-tips.json Outdated Show resolved Hide resolved
@theJiawen theJiawen requested a review from patmill as a code owner July 21, 2023 20:43
@theJiawen
Copy link
Contributor Author

theJiawen commented Jul 21, 2023

oops, I did a rebase, and it seems messed up the commit history. Should I do merging instead of rebasing? @dmichon-msft

Update: reverted the changes

@octogonz
Copy link
Collaborator

Tested using the https://github.com/microsoft/rush-example repo:

  • rush init produces a correct config file
  • rush check reports a custom tip
  • defaultMessagePrefix works
  • messagePrefix works
  • duplicate tipId causes an error
  • misspelled tipId causes an error
  • Invalid JSON causes a JSON schema validation error

👍

@octogonz octogonz merged commit c745085 into microsoft:main Aug 12, 2023
5 checks passed
@octogonz
Copy link
Collaborator

octogonz commented Feb 6, 2024

Documentation for this feature is here: https://rushjs.io/pages/maintainer/custom_tips/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants