Support custom comment prefixes on schema artifacts - #1296
Merged
Conversation
jwils
requested review from
BrianSigafoos-SQ,
bsorbo,
ellisandrews-toast,
jwondrusch,
marcdaniels-toast,
myronmarston and
rossroberts-toast
as code owners
July 7, 2026 15:14
This was referenced Jul 7, 2026
myronmarston
approved these changes
Jul 7, 2026
jwils
force-pushed
the
joshuaw/schema-artifact-comment-prefix
branch
from
July 7, 2026 16:22
c178c96 to
a4d28b4
Compare
The generated-file preamble that `SchemaArtifact` writes has always used `#` comments, which is only valid for YAML and GraphQL SDL artifacts. Extensions that generate artifacts in other formats (e.g. a `.proto` schema, where comments use `//`) need to control the comment syntax, so `new_raw_artifact` now accepts a `comment_prefix` keyword (defaulting to `#`).
jwils
force-pushed
the
joshuaw/schema-artifact-comment-prefix
branch
from
July 7, 2026 16:23
a4d28b4 to
e3a237b
Compare
jwils
enabled auto-merge (squash)
July 7, 2026 16:30
jwils
added a commit
that referenced
this pull request
Jul 7, 2026
Creates the new `elasticgraph-proto_ingestion` extension gem and wires it into the repo — bundle/lockfile, RBS collection, docker demo image, doctest helper, dependency diagrams, and the `run_gem_specs` flatware list — without any of the Protocol Buffers generation logic yet. The gem currently just defines its artifact file name constants and an `APIExtension` entry point that does not customize anything. Splitting the gem creation out this way keeps the follow-up PR that adds the actual generation logic (#1080) contained entirely to the gem's own directory. Second of a three-PR sequence: #1296 (artifact comment prefixes), this scaffold, then #1080 (the generation logic).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The generated-file preamble that
SchemaArtifactwrites has always used#comments, which is only valid for YAML and GraphQL SDL artifacts. Extensions that generate artifacts in other formats need to control the comment syntax — the upcomingelasticgraph-proto_ingestionextension generates a.protoschema artifact, where comments use//.new_raw_artifactnow accepts acomment_prefixkeyword (defaulting to#), andSchemaArtifactrenders its preamble with the configured prefix.First of a three-PR sequence introducing
elasticgraph-proto_ingestion: this change, then the gem scaffold, then the generation logic.