Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

feat(parser-emoji): ability to define other emoji#963

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
justin-pierce wants to merge1 commit intopython-semantic-release:master
base:master
Choose a base branch
Loading
fromoctophases:other-emoji

Conversation

@justin-pierce
Copy link

@justin-piercejustin-pierce commentedJun 19, 2024
edited
Loading

I didn't like how using emojis that didn't trigger a release would dump them all together in a generic "Other" category in release notes.

This simply lets you (optionally) define emoji inother_tagsnon_triggering_tags so they appear under their own header.

Side note: is there a reason the emoji id (like:construction_worker:) is used instead of the actual emoji (like 👷) in the default configuration? In my personal configurations I just use the actual emojis and it seems to work fine and I like that it renders the emoji in my IDE.

@codejedi365codejedi365 self-requested a reviewJune 21, 2024 15:17
Copy link
Contributor

@wyardleywyardley left a comment

Choose a reason for hiding this comment

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

I like the idea; might even be good to bake in some common non-triggering types as defaults (even for non-triggering types like docs / ci / chore)?

other_tags seems fine; maybenon_triggering_tags or something similar could also work?

I guesshttps://github.com/carloscuesta/gitmoji/blob/master/packages/gitmojis/src/gitmojis.json is the closest thing to a standard here?

@wyardley
Copy link
Contributor

wyardley commentedJun 21, 2024
edited
Loading

Side note: is there a reason the emoji id (like 👷) is used instead of the actual emoji

Just commenting as a user here, but I do personally think having:foo: vs the actual emoji just seems safer to me somehow 🤷. Seems like it could be less likely for problems to come up around encoding or viewing the files at any rate.

justin-pierce reacted with thumbs up emoji

@justin-pierce
Copy link
Author

justin-pierce commentedJun 21, 2024
edited
Loading

I like the idea; might even be good to bake in some common non-triggering types as defaults (even for non-triggering types like docs / ci / chore)?

Yeah for defaults I (at least think I) added:

  • :pencil: for docs (I use 📝:memo: but the tests here already mentioned:pencil: relating to docs so I kept it)
  • :construction_worker: for cicd
  • :recycle: for refactoring

Wasn't sure how far to take the defaults. I like gitmoji for reference (and used it for defaults other than what's noted) but I personally deviate a little and think simpler is better, as there can be some overlap/ambiguity when there's too many (and at some point it's annoying to remember them all when they get super specific). I think it'd at least make sense to change:pencil: to:memo: to match gitmoji.

other_tags seems fine; maybenon_triggering_tags or something similar could also work?

Yeah wasn't sure what to call it. I looked at how the other parsers worked but I preferred how the emoji parser didn't double up with anall list.non_triggering_tags also makes sense.

Just commenting as a user here, but I do personally think having :foo: vs the actual emoji just seems safer to me somehow 🤷. Seems like it could be less likely for problems to come up around encoding or viewing the files at any rate.

Yeah figured it was something along those lines -- just wanted to make sure I wasn't missing any specific risks when I use emoji themselves, as they seem to render everywhere I need them to (whereas the codes don't render in pycharm, for example). Also harder to have a typo when using actual emoji. Easy enough to customize so I don't think it's an issue, was just curious. 👍

@justin-pierce
Copy link
Author

went ahead and swapped:pencil: with:memo: and changedother_tags tonon_triggering_tags

@codejedi365
Copy link
Contributor

codejedi365 commentedJun 24, 2024
edited
Loading

Sorry for the delay, been traveling, hopefully get to the review this week.

Initially, I'm not seeingany (there are some adjustments to constants) testing changes related to the changelog generation you were hoping for so have you considered how to validate your fix and how to prevent it from regression later on? I do realize some of the changelog testing is complicated.

@justin-pierce
Copy link
Author

justin-pierce commentedJun 24, 2024
edited
Loading

Sorry for the delay, been traveling, hopefully get to the review this week.

Initially, I'm not seeingany (there are some adjustments to constants) testing changes related to the changelog generation you were hoping for so have you considered how to validate your fix and how to prevent it from regression later on? I do realize some of the changelog testing is complicated.

Yeah was tough for me to parse the testing structure. I did add/edit these intest_emoji.py:

        # No release with specified emoji        (            ":memo: Documentation changes",            LevelBump.NO_RELEASE,            ":memo:",            [":memo: Documentation changes"],            [],        ),        # No release with random emoji        (            ":construction: Work in progress",            LevelBump.NO_RELEASE,            "Other",            [":construction: Work in progress"],            [],        ),

My understanding is that this does test a commit message's effect on both the type of release and how it appears in changelogs. The first tests to make sure 📝 puts it under the 📝 header because 📝 is defined in the defaults. The second uses 🚧, which is not in the defaults, so it tests to confirm it's under theOther header (how it worked before this change).

Sounds like I'm missing something though?

@github-actions
Copy link

This PR is stale because it has not been confirmed or considered ready for merge by the maintainers but has been open 60 days with no recent activity. It will be closed in 10 days, if no further activity occurs. Please make sure to add the proper testing, docs, and descriptions of changes before your PR can be merged. Thank you for your contributions.

@codejedi365codejedi365 added confirmedPrevent from becoming stale and removed stale confirmedPrevent from becoming stale labelsSep 7, 2024
@codejedi365
Copy link
Contributor

I'm sorry, this was my fault, I was extremely busy the past two months and I didn't get back to reviewing this PR a while back. I will review more over the weekend. I appreciate your contribution to the project.

justin-pierce reacted with thumbs up emoji

@codejedi365codejedi365 added confirmedPrevent from becoming stale and removed stale labelsNov 6, 2024
@github-actions
Copy link

It has been 60 days since the last update on this confirmed PR. @python-semantic-release/team can you provide an update on the status of this PR?

@github-actionsgithub-actionsbot added the needs-updateNeeds status update from maintainers labelJan 6, 2025
@github-actionsgithub-actionsbot removed the needs-updateNeeds status update from maintainers labelJun 6, 2025
@github-actions
Copy link

It has been 90 days since the last update on this confirmed PR. @python-semantic-release/team can you provide an update on the status of this PR?

@github-actionsgithub-actionsbot added the needs-updateNeeds status update from maintainers labelSep 5, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@codejedi365codejedi365Awaiting requested review from codejedi365

1 more reviewer

@wyardleywyardleywyardley left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

confirmedPrevent from becoming staleneeds-updateNeeds status update from maintainers

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@justin-pierce@wyardley@codejedi365

[8]ページ先頭

©2009-2025 Movatter.jp