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

Add MethodSpec.Builder.clearModifiers() method #114

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

Conversation

ash211
Copy link

@ash211 ash211 commented Nov 5, 2024

Before this PR

Can't easily migrate palantir/safe-logging's usage pattern here because Palantir javapoet made MethodSpec.Builder.modifiers to be append-only, but that usage clears the modifiers.

After this PR

==COMMIT_MSG==
Add MethodSpec.Builder.clearModifiers() method
==COMMIT_MSG==

Possible downsides?

None known

@changelog-app
Copy link

changelog-app bot commented Nov 5, 2024

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Add MethodSpec.Builder.clearModifiers() method

Check the box to generate changelog(s)

  • Generate changelog entry

Copy link
Member

@pkoenig10 pkoenig10 left a comment

Choose a reason for hiding this comment

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

I'd prefer not to add destructive methods to builders. If you need to remove items previously added to a builder, just start a new builder.

@pkoenig10
Copy link
Member

Can't easily migrate palantir/safe-logging's usage pattern here

In this particular case, it sounds like we probably want to change the return type of createLoggerBridge() to more properly what we need. For example, changing it from a TypeSpec to a method-less TypeSpec along with modifier-less MethodSpecs, for example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants