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

chore: Updating the prlinter #22113

Merged
merged 5 commits into from
Sep 20, 2022
Merged

chore: Updating the prlinter #22113

merged 5 commits into from
Sep 20, 2022

Conversation

Naumel
Copy link
Contributor

@Naumel Naumel commented Sep 19, 2022

Adding the title check for all submitted PRs, not only the breaking change ones.


All Submissions:

Adding new Unconventional Dependencies:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Adding the title check for all submitted PRs, not only the breaking change ones.
@gitpod-io
Copy link

gitpod-io bot commented Sep 19, 2022

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 19, 2022
@github-actions github-actions bot added the p2 label Sep 19, 2022
@aws-cdk-automation aws-cdk-automation requested a review from a team September 19, 2022 14:38
@Naumel
Copy link
Contributor Author

Naumel commented Sep 19, 2022

@Mergifyio update

@mergify
Copy link
Contributor

mergify bot commented Sep 19, 2022

update

✅ Branch has been successfully updated

@Naumel Naumel marked this pull request as ready for review September 19, 2022 14:41
Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably safer to not change the existing behavior of the breaking change checker. This specific change, requiring a module always breaks cases today where we could do chore: blabla (that is now illegal because it's not formatted like chore(something): blabla). Same for fix or feat.

Why not add a new check that PR titles conform to "conventional commits", just like the check that we used to have but are now missing?

The format should be:

<type> [ "(" <arbitrary text> ")" ] ":" <arbitrary text>
<type> := "feat" | "fix" | "chore" | "refactor" | "docs"  (I think that's most of what we use)

@Naumel
Copy link
Contributor Author

Naumel commented Sep 19, 2022

From https://www.conventionalcommits.org/en/v1.0.0/#summary

types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:

@TheRealAmazonKendra
Copy link
Contributor

This is going to conflict with the changes in #22029.

@Naumel Naumel changed the title chore(core): Updating the prlinter chore (core) : Updating the prlinter Sep 20, 2022
@Naumel Naumel changed the title chore (core) : Updating the prlinter chore(core): Updating the prlinter Sep 20, 2022
@Naumel Naumel changed the title chore(core): Updating the prlinter chores(core): Updating the prlinter Sep 20, 2022
@Naumel Naumel changed the title chores(core): Updating the prlinter chore(core): Updating the prlinter Sep 20, 2022
@Naumel Naumel changed the title chore(core): Updating the prlinter chore: Updating the prlinter Sep 20, 2022
@Naumel Naumel changed the title chore: Updating the prlinter chores: Updating the prlinter Sep 20, 2022
@Naumel Naumel changed the title chores: Updating the prlinter chore(aws-made-up): Updating the prlinter Sep 20, 2022
@Naumel Naumel changed the title chore(aws-made-up): Updating the prlinter chores(aws-made-up): Updating the prlinter Sep 20, 2022
@Naumel Naumel changed the title chores(aws-made-up): Updating the prlinter chore: Updating the prlinter Sep 20, 2022
The current check is only for title prefix.

The accepted prefixes: feat, fix, build, chore, ci, docs, style, refactor, perf, test.
Specifying a module (e.g. `(aws-s3)`) is optional, and the subsequent other two characters are `: `.
@Naumel
Copy link
Contributor Author

Naumel commented Sep 20, 2022

@Mergifyio update

@mergify
Copy link
Contributor

mergify bot commented Sep 20, 2022

update

✅ Branch has been successfully updated

Preserving past behavior  and tests' outcome.
@Naumel Naumel added pr/do-not-merge This PR should not be merged at this time. and removed pr/do-not-merge This PR should not be merged at this time. labels Sep 20, 2022
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 482496f
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Contributor

mergify bot commented Sep 20, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 6840bc3 into main Sep 20, 2022
@mergify mergify bot deleted the Naumel-patch-1 branch September 20, 2022 08:29
homakk pushed a commit to homakk/aws-cdk that referenced this pull request Dec 1, 2022
Adding the title check for all submitted PRs, not only the breaking change ones.


----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants