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

build(plugin-keychain-vault): fix gradle error Redeclaration: ResponseType #2732

Merged
merged 1 commit into from
Oct 16, 2023

Conversation

petermetz
Copy link
Contributor

Primary change:

  1. The codegen script now runs the clean script prior to its own
    execution automatically (so that we don't forget to run it).
    If we don't run the clean script prior to the code generation, then
    the code generation doesn't delete old files just dumps the new ones
    next to the old ones which leads to problems after upgrading the generator:
    A newer version of the generator usually ships with different templates
    that have restructured their code files so we end up with duplicates
    breaking the build (unless we do a clean prior to codegen).

As for the actual build issue that this task was about:
It was a cross-cutting concern because the root cause of it was that
we were not cleaning up properly prior to the codegen task but this
applied to all the 2 or so dozen kotlin projects that we generate.

So as part of the solution I've ran the clean script and ran codegen
again which now produces code that builds without issues.

Secondary changes:

Modified the clean script in the root project the following ways:

  1. It is now cleaning up generated kotlin OpenAPI code as well
    (previously it was not doing this at all despite what the name of the
    script might suggest...)
  2. It excludes all the openapi-generator-ignore files from being deleted
    which has the beneficial side-effect that they do not get re-generated
    with their default contents which would be missing files that we want
    to ignore in addition to them.
  3. The clean script NO LONGER DELETES the
    src/main/typescript/generated/proto/protoc-gen-ts sub-folder of the
    cmd-api-server package because the contents of it were not being re-
    generated by the codegen script for some reason. This is something
    to be fixed properly in the future but for now I just had to cut my
    losses and make it work.

This depends on the PR being merged above because they both touch on
the generated code but in different ways. If we merged this one first,
the other one would have its diff emptied out (stealing the show).

[skip ci]

Fixes #2730

Depends on https://github.com/hyperledger/cacti/pull/2729

Signed-off-by: Peter Somogyvari [email protected]

@petermetz petermetz enabled auto-merge (rebase) October 2, 2023 21:56
@petermetz petermetz changed the title Petermetz/issue2730 build(plugin-keychain-vault): fix gradle error Redeclaration: ResponseType Oct 2, 2023
@github-actions github-actions bot removed the dependent label Oct 5, 2023
@github-actions
Copy link

github-actions bot commented Oct 5, 2023

This PR/issue depends on:

@petermetz petermetz force-pushed the petermetz/issue2730 branch from 82406b0 to 1cb1155 Compare October 5, 2023 02:54
Copy link
Contributor

@izuru0 izuru0 left a comment

Choose a reason for hiding this comment

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

LGTM

@petermetz petermetz disabled auto-merge October 16, 2023 07:39
…eType

Primary change:
---------------

1. The codegen script now runs the clean script prior to its own
execution automatically (so that we don't forget to run it).
If we don't run the clean script prior to the code generation, then
the code generation doesn't delete old files just dumps the new ones
next to the old ones which leads to problems after upgrading the generator:
A newer version of the generator usually ships with different templates
that have restructured their code files so we end up with duplicates
breaking the build (unless we do a clean prior to codegen).

As for the actual build issue that this task was about:
It was a cross-cutting concern because the root cause of it was that
we were not cleaning up properly prior to the codegen task but this
applied to all the 2 or so dozen kotlin projects that we generate.

So as part of the solution I've ran the clean script and ran codegen
again which now produces code that builds without issues.

Secondary changes:
-----------------

Modified the clean script in the root project the following ways:
1. It is now cleaning up generated kotlin OpenAPI code as well
(previously it was not doing this at all despite what the name of the
script might suggest...)
2. It excludes all the openapi-generator-ignore files from being deleted
which has the beneficial side-effect that they do not get re-generated
with their default contents which would be missing files that we want
to ignore in addition to them.
3. The clean script NO LONGER DELETES the
`src/main/typescript/generated/proto/protoc-gen-ts` sub-folder of the
cmd-api-server package because the contents of it were not being re-
generated by the `codegen` script for some reason. This is something
to be fixed properly in the future but for now I just had to cut my
losses and make it work.

This depends on the PR being merged above because they both touch on
the generated code but in different ways. If we merged this one first,
the other one would have its diff emptied out (stealing the show).

[skip ci]

Fixes hyperledger-cacti#2730

Depends on https://github.com/hyperledger/cacti/pull/2729

Signed-off-by: Peter Somogyvari <[email protected]>
@petermetz petermetz force-pushed the petermetz/issue2730 branch from 1cb1155 to 117426c Compare October 16, 2023 07:40
@petermetz petermetz merged commit 117426c into hyperledger-cacti:main Oct 16, 2023
4 checks passed
@petermetz petermetz deleted the petermetz/issue2730 branch October 16, 2023 07:41
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.

build(plugin-keychain-vault): fix gradle error Redeclaration: ResponseType
3 participants