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.

Sign up for GitHub

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

Jump to bottom

Split out separate top level modules #415

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

Split out separate top level modules #415

wants to merge 4 commits into from

Conversation

sfackler
Copy link
Member

Before this PR

Generated objects, errors, clients, and endpoints were all included together in the same module hierarchy. This opens up the possibility of name collisions (e.g. if you have a service called Foo and an object called FooEndpoints), and is a blocker for conversion of client code generation to use the new macro.

After this PR

==COMMIT_MSG==
Generated code is now split into separate top-level modules for objects, errors, clients, and endpoints.
==COMMIT_MSG==

Closes #279

@sfackler sfackler requested a review from a team January 20, 2025 19:38
@changelog-app
Copy link

changelog-app bot commented Jan 20, 2025 •
edited by sfackler
Loading

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

Generated code is now split into separate top-level modules for objects, errors, clients, and endpoints.

Check the box to generate changelog(s)

  • Generate changelog entry

sfackler
sfackler commented Jan 20, 2025
View reviewed changes
conjure-codegen/src/lib.rs
@@ -279,13 +279,17 @@
//!
//! * `server-request-context` - The generated server trait method will have an additional
//! `RequestContext` argument providing lower level access to request and response information.
//! * `server-limit-request-size: <size>` - Sets the maximum request body size for endpoints with
//! serializable request bodies. `<size>` should be a human-readable byte count (e.g. `50Mi` or
//! `100Ki`). Defaults to `50Mi`.
Copy link
Member Author

Choose a reason for hiding this comment

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

I forgot to document this in #380

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Partition objects/errors/clients/endpoints into separate top-level modules
2 participants
@sfackler @svc-changelog