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

refactor!: remove second opts argument in Honeybadger.notify #499

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

joshuap
Copy link
Member

@joshuap joshuap commented Oct 19, 2023

This moves to keyword arguments exclusively. See #426 for further context.

BREAKING CHANGE: The following signature is no longer supported:

Honeybadger.notify("test", {tags: 'testing, hash'})

Instead, you must do this:

Honeybadger.notify("test", tags: 'testing, hash')

This moves to keyword arguments exclusively. It's a breaking change
because the following signature is no longer supported:

Honeybadger.notify("test", {tags: 'testing, hash'})
@subzero10
Copy link
Member

👏 Kudos for the conventional commit PR naming style! With conventional commits, we can automate versioning, which will eventually help with automated releases.

There's one minor correction: everything should be lowercase:
chore!: remove second opts argument in Honeybadger.notify

Finally, I'm wondering if chore is the best commit type here; usually chores don't really come with breaking changes. Maybe refactor?

Copy link
Contributor

@halfbyte halfbyte left a comment

Choose a reason for hiding this comment

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

Looks good to me. Sorry @joshuap for not waiting for your comment, otherwise my PR could have been this, of course.

@joshuap joshuap changed the title chore!: Remove second opts argument in Honeybadger.notify chore!: remove second opts argument in Honeybadger.notify Oct 23, 2023
@joshuap
Copy link
Member Author

joshuap commented Oct 23, 2023

Finally, I'm wondering if chore is the best commit type here; usually chores don't really come with breaking changes. Maybe refactor?

I'm not sure refactor is it since refactoring shouldn't introduce any changes, right?

@subzero10
Copy link
Member

I'm not sure refactor is it since refactoring shouldn't introduce any changes, right?

Good point! Though, I usually prefer this definition, taken from here:
refactor => A code change that neither fixes a bug nor adds a feature
which could allow changes (?).

One additional point is that usually automatic changelog generation will ignore chore commit types (though we could add chores to the ruby changelog when we integrate with conventional commits).

@subzero10
Copy link
Member

One additional point is that usually automatic changelog generation will ignore chore commit types (though we could add chores to the ruby changelog when we integrate with conventional commits).

@joshuap I confirmed that this is the case with our automated versioning and changelog generation on the ruby package. chore commits are ignored. So, I think it's best to change the title of this PR.

@joshuap joshuap changed the title chore!: remove second opts argument in Honeybadger.notify refactor!: remove second opts argument in Honeybadger.notify Oct 30, 2023
@joshuap
Copy link
Member Author

joshuap commented Oct 30, 2023

One additional point is that usually automatic changelog generation will ignore chore commit types (though we could add chores to the ruby changelog when we integrate with conventional commits).

@joshuap I confirmed that this is the case with our automated versioning and changelog generation on the ruby package. chore commits are ignored. So, I think it's best to change the title of this PR.

done!

@joshuap joshuap added this to the 6.0.0 milestone Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants