feat: allow git commit type to be changed in configuration #462
Conversation
|
@tobiasbueschel is attempting to deploy a commit to the All Contributors Team on Vercel. A member of the Team first needs to authorize it. |
tobiasbueschel
changed the title
tobiasbueschel
changed the title
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Not sure why the tests are failing 🤔 But I pointed https://github.com/apps/all-contributors-preview to the preview deployment. Can you give it a try on a test repository to see if it all works as expected? Make sure you don't have https://github.com/apps/allcontributors already installed in the same repo |
I've updated the tests which should also fix the deployed version - sorry for the oversight as I missed updating one variable! Here's the test repository, once the new version is deployed I can test it :) |
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #462 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 16 16
Lines 451 453 +2
Branches 53 54 +1
=========================================
+ Hits 451 453 +2
☔ View full report in Codecov by Sentry. |
ready 👍🏼 |
I'll have to ask you to redeploy again :) Glad that we tested as I found that the PR title updated with the correct commit type, but the two commits that were push as part of the PR still had the old commit type. I've pushed a fix to update it - and now it should work fully :) |
| }); | ||
| } | ||
| } | ||
|
|
||
| async createOrUpdateFiles({ filesByPath, branchName, convention }) { | ||
| async createOrUpdateFiles({ filesByPath, branchName, convention, commitType }) { |
There was a problem hiding this comment.
On that note, we're handing down a lot of config like variables to these class methods. Perhaps in a later PR one could refactor this so that we set up the branchName, convention, commitType etc. when the Repository class is instantiated.
Great catch! I updated the webhook URL. I actually found that there is URL that remains the same for this pull request:https://app-git-fork-tobiasbueschel-master-all-contributors.vercel.app/ Next time I'll know :D |
|
Thanks again @gr2m the demo repository works now: tobiasbueschel/all-contributors-test#4 |
|
@all-contributors please add @tobiasbueschel for code and testing |
|
I've put up a pull request to add @tobiasbueschel! 🎉 |
|
🎉 This PR is included in version 1.19.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
What: This allows users of the All Contributors app to configure the Git commit tag that the tool should use to add new contributors.
Why: Adding this will help users to customize the Git commit tag, which can be helpful in situations where you don't want that All Contributors changes appear in an auto-generated changelog that considers e.g., all
docscommits.Instead, one can overwrite it to be
choreand therefore the All Contributors changes wouldn't appear in a changelog. One could argue that only features or bug fixes should appear in changelogs, but I have a few use cases where we're developing documentation apps using Docusaurus and configured semantic-release to also consider anydocscommit tags for the changelog.How: I've followed a similar pattern that was used for
commitConventionand introducedcommitTypewhich is configurable.Checklist:
commitConventionand so also didn't add one forcommitTypeBot Usage
Do let me know if there's anything else I shall change in this PR? :)
Thanks