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: add breaking change to title regex #12754

Merged
merged 3 commits into from
Jan 28, 2021

Conversation

eschutho
Copy link
Member

@eschutho eschutho commented Jan 26, 2021

SUMMARY

Per #12566 [SIP 57] adding a regex check to allow for a title that has a breaking-change prefix. Authors should use this prefix for any fixes, features, perf, refactor, etc that is a breaking change.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Changes UI
  • Requires DB Migration.
  • Confirm DB Migration upgrade and downgrade tested.
  • Introduces new feature or API
  • Removes existing feature or API

@eschutho eschutho changed the title add breaking change to title regex chore: add breaking change to title regex Jan 26, 2021
@codecov-io
Copy link

codecov-io commented Jan 26, 2021

Codecov Report

Merging #12754 (8afec73) into master (55c8f9b) will decrease coverage by 2.51%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #12754      +/-   ##
==========================================
- Coverage   66.68%   64.16%   -2.52%     
==========================================
  Files        1021      488     -533     
  Lines       50008    30403   -19605     
  Branches     4905        0    -4905     
==========================================
- Hits        33346    19508   -13838     
+ Misses      16532    10895    -5637     
+ Partials      130        0     -130     
Flag Coverage Δ
cypress ?
javascript ?
python 64.16% <ø> (+0.07%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
superset/db_engines/hive.py 0.00% <0.00%> (-85.72%) ⬇️
superset/db_engine_specs/hive.py 73.84% <0.00%> (-17.31%) ⬇️
superset/utils/cache.py 76.34% <0.00%> (-8.77%) ⬇️
superset/db_engine_specs/presto.py 88.09% <0.00%> (-0.44%) ⬇️
superset/models/core.py 88.58% <0.00%> (-0.28%) ⬇️
superset/viz.py 59.02% <0.00%> (-0.04%) ⬇️
superset/charts/schemas.py 100.00% <0.00%> (ø)
superset/common/query_context.py 82.58% <0.00%> (ø)
...ntend/src/dashboard/components/PublishedStatus.jsx
.../src/dashboard/components/menu/PopoverDropdown.jsx
... and 534 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 55c8f9b...8afec73. Read the comment docs.

@ktmud
Copy link
Member

ktmud commented Jan 26, 2021

The prefixes are task types. "Breaking change" sounds more like a flag or label.

Conventional commits specifies breaking changes should add ! to task type, or include BREAKING CHANGE: in the footer. E.g.

refactor!: drop support for Python 3.6

or

refactor!: drop support for Python 3.6

BREAKING CHANGE: as discussed in #xxxx, Python 3.6 is no longer supported.

I think it'd be worthwhile following the best practices from the community.

@eschutho
Copy link
Member Author

The prefixes are task types. "Breaking change" sounds more like a flag or label.

Conventional commits specifies breaking changes should add ! to task type, or include BREAKING CHANGE: in the footer. E.g.

refactor!: drop support for Python 3.6

or

refactor!: drop support for Python 3.6

BREAKING CHANGE: as discussed in #xxxx, Python 3.6 is no longer supported.

I think it'd be worthwhile following the best practices from the community.

Thanks, this is a good resource @ktmud.

@eschutho eschutho marked this pull request as draft January 26, 2021 22:56
@eschutho eschutho marked this pull request as ready for review January 27, 2021 01:47
@ktmud ktmud changed the title chore: add breaking change to title regex chore: add breaking change (!) to title regex Jan 27, 2021
@ktmud ktmud changed the title chore: add breaking change (!) to title regex chore: add breaking change to title regex Jan 27, 2021
@@ -19,7 +19,7 @@ jobs:
submodules: recursive
- uses: ./.github/actions/pr-lint-action
with:
title-regex: "^(build|chore|ci|docs|feat|fix|perf|refactor|style|test|other)((.+))?:\\s.+"
title-regex: "^(build|chore|ci|docs|feat|fix|perf|refactor|style|test|other)(\\(.+\\))?(\\!)?:\\s.+"
Copy link
Member Author

Choose a reason for hiding this comment

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

@nytai I escaped the parens here.. was that intentional originally? Also, do you know the reason for the last s?

Copy link
Member

Choose a reason for hiding this comment

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

TBH, I'm also a little confused by this regex. I lifted it from this file https://github.com/apache/superset/blob/dc893fe1b3b86e2921bb77e08a531db46b3f8e5d/.github/prlint.json
that @mistercrunch added

Copy link
Member

@nytai nytai Jan 27, 2021

Choose a reason for hiding this comment

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

Ok, this is making more sense now. Looks like there's some yaml escaping in here too. I'm seeing there was a mistake in the original parens, so the previous regex allowed anything after the prefix and before the :, so buildskjdsfsdfsdbjfds: dsfds would have been valid 🤣. The last \s is the ensure there's white space after the :

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, gotcha. yeah, the yaml escaping threw me off on the \\s at first too. Luckily the linter caught the new ones.

@eschutho
Copy link
Member Author

rebuilding

@eschutho eschutho closed this Jan 27, 2021
@eschutho eschutho reopened this Jan 27, 2021
@nytai nytai merged commit 41b990f into apache:master Jan 28, 2021
@nytai nytai deleted the elizabeth/breaking-change-title-prefix branch January 28, 2021 02:48
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.2.0 labels Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels preset-io size/XS 🚢 1.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants