Skip to content

Commit 53d6799

Browse files
authored
feat: optionally output versions used to generate files (#1040)
### Description - Add the `annotateFilesWithVersion` option so that changes are correctly captured in CI (eliminating noise on each file) - Added this option to the README
1 parent d444507 commit 53d6799

File tree

258 files changed

+23
-767
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

258 files changed

+23
-767
lines changed

README.markdown

+3-3

integration/angular/simple-message.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/async-iterable-services-abort-signal/simple.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/async-iterable-services/simple.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/avoid-import-conflicts-folder-name/ui.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/avoid-import-conflicts-folder-name/ui/simple.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/avoid-import-conflicts-types-only/simple.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/avoid-import-conflicts-types-only/simple2.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/avoid-import-conflicts/simple.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/avoid-import-conflicts/simple2.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/barrel-imports/bar.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/barrel-imports/foo.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/batching-with-context-esModuleInterop/batching.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/batching-with-context/batching.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/batching/batching.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/before-after-request-streaming/example.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/before-after-request-streaming/google/protobuf/wrappers.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/before-after-request/simple.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/before-after-request/simple2.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/bytes-as-base64-browser/message.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/bytes-as-base64-node/message.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/bytes-as-base64/message.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/bytes-node/google/protobuf/wrappers.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/bytes-node/point.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/codegen.ts

+10
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ async function generate(binFile: string, baseDir: string, parameter: string) {
3131
const { protocVersion, tsProtoVersion } = await getVersions(request);
3232

3333
const options = optionsFromParameter(parameter || "");
34+
35+
// we have to check for the parameter as a string here because the
36+
// default value of the parameter is true.
37+
if (parameter.includes("annotateFilesWithVersion=true")) {
38+
options.annotateFilesWithVersion = true;
39+
} else {
40+
// we practically always want to not annotate files with version in tests
41+
// as this will make snapshots fail on every version bump
42+
options.annotateFilesWithVersion = false;
43+
}
3444
const typeMap = createTypeMap(request, options);
3545

3646
for (let file of request.protoFile) {

integration/const-enum/const-enum.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/default-with-custom-metadata/default-with-custom-metadata.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/default-with-metadata/default-with-metadata.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/emit-default-values-json/google/protobuf/timestamp.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/emit-default-values-json/test.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/enums-as-literals-with-string-enums/enums-as-literals-with-string-enums.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/enums-as-literals/enums-as-literals.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/enums-with-unrecognized-name-value/test.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/extensions/test.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/fieldmask-optional-all/fieldmask-optional.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/fieldmask-optional-all/google/protobuf/field_mask.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/fieldmask/fieldmask.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/fieldmask/google/protobuf/field_mask.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/fieldoption-jstype-with-forcelong-bigint/fieldoption-jstype-with-forcelong-bigint.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/fieldoption-jstype-with-forcelong-long/fieldoption-jstype-with-forcelong-long.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/fieldoption-jstype-with-forcelong-number/fieldoption-jstype-with-forcelong-number.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/fieldoption-jstype-with-forcelong-string/fieldoption-jstype-with-forcelong-string.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/fieldoption-jstype/fieldoption-jstype.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/file-suffix/child.pb.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/file-suffix/google/protobuf/timestamp.pb.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/file-suffix/parent.pb.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration/from-partial-no-initialize/test.ts

-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)