-
Notifications
You must be signed in to change notification settings - Fork 867
Added devconfig-validator and comment handler #3816
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
base: development
Are you sure you want to change the base?
Conversation
``` | ||
|
||
- `changeLogMessages`: (Required) An array of messages to include in the changelog under the core section. | ||
- `type`: (Required) The part of the version string to increment. Valid values are `minor` and `patch`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might want to give guidance on when to use patch
versus minor
.
|
||
- `changeLogMessages`: (Required) An array of messages to include in the changelog under the core section. | ||
- `type`: (Required) The part of the version string to increment. Valid values are `minor` and `patch`. | ||
- `updateMinimum`: (Required) Whether to update the minimum core version for all services. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Give an example of when they might want to set this to true
.
You can use the provided script to generate a DevConfig file: | ||
|
||
``` | ||
./buildtools/add-devconfig.bat |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Call out the bat file for windows or ./buildtools/add-devconfig.sh
for mac/linux
echo "No DevConfig files found in this PR" | ||
fi | ||
|
||
- name: Check if DevConfig is needed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I might be missing something but depending on when the contributor branched from development
there might be dev config files for other unshipped PRs in the forked branch. Would the workflow say all is good because there is a dev config in the folder even though it is unrelated to what the PR does?
@@ -0,0 +1,219 @@ | |||
name: DevConfig Validator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this workflow be skipped if the target is anything other then development or the V3 development? What I'm thinking is the PR is an incremental work for a feature branch a dev config is not required.
Description
The DevConfig Validator is a GitHub workflow that automatically checks if a DevConfig file is needed for your PR and helps you create one if necessary. The workflow detects changes to core and service files and determines if a DevConfig file is required.
Workflow
Commands
The DevConfig Validator supports the following commands that you can use in PR comments:
/add-devconfig
: Adds the preview DevConfig file to your PR. You can also provide your own JSON to customize the DevConfig./delete-devconfig
: Removes the DevConfig file from your PR./amend-devconfig
: Updates the existing DevConfig file with new JSON content.Example usage:
Test PR showing interaction: https://github.com/aws/aws-sdk-net-staging-dev/pull/1
Associated PR for the offline tool referenced by the validator: #3811
TODO:
Motivation and Context
Need a way for developers (Internal/External) to know devconfig files are needed and to give the best starting point for getting those devconfig files added easily to their PRs.
Testing
Test PR showing interaction: https://github.com/aws/aws-sdk-net-staging-dev/pull/1
Screenshots (if appropriate)
Types of changes
Checklist
License