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

refactor: retire connector plugin specific container images, fix docs #3409

Conversation

petermetz
Copy link
Contributor

BREAKING CHANGE: Container images are being deleted here and will also
get deleted from GHCR. Though the public APIs of the Typescript code
do not change, still, some parts of the documentation will become invalid
until we update it to match the changes here.
I invested a large amount of effort into doing this documentation update
as part of this change but it is very likely that I've missed a few spots
and therefore it is best to mark this as a breaking change in my opinion
to call attention to the fact that we still have ways to go with updating
the documentation around these container images.

  1. Deleted all the container images that were just wrappers around the
    cmd-api-server container image installing their own npm package from
    the registry.
    The reason for this is that they ended up just being maintenance burden
    since we can achieve the exact same things just by re-using the API server's
    container image directly.
  2. This way we don't have to deal with CVEs in 10x container images when
    it's really just the one container image that we use as the base that needs
    to deal with them anyway.
  3. I also spent quite a bit of effort in this change to update the README.md
    files of the packages where previously we had plugin specific container images
    defined so that the README.md files have the tutorials that are more up to
    date compared to how they were (most of them had the tutorials completely
    broken for a long while which was causing a lot of difficulties to the
    newcomers who were trying to work with the packages).
  4. The reason why they got so out of date traces back to the undue maintenance
    burden of keeping separate images for each connector plugin. We hope that
    with this simplification we can keep the documentation continuously up to
    date since it will require less time do so.
  5. Also deleted the ci.yaml container building jobs which were relevant to
    the scope of this change so that we also save on CI resources, another
    long-running project that's been in need of some attention from the maintainers.

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

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

BREAKING CHANGE: Container images are being deleted here and will also
get deleted from GHCR. Though the public APIs of the Typescript code
do not change, still, some parts of the documentation will become invalid
until we update it to match the changes here.
I invested a large amount of effort into doing this documentation update
as part of this change but it is very likely that I've missed a few spots
and therefore it is best to mark this as a breaking change in my opinion
to call attention to the fact that we still have ways to go with updating
the documentation around these container images.

1. Deleted all the container images that were just wrappers around the
cmd-api-server container image installing their own npm package from
the registry.
The reason for this is that they ended up just being maintenance burden
since we can achieve the exact same things just by re-using the API server's
container image directly.
2. This way we don't have to deal with CVEs in 10x container images when
it's really just the one container image that we use as the base that needs
to deal with them anyway.
3. I also spent quite a bit of effort in this change to update the README.md
files of the packages where previously we had plugin specific container images
defined so that the README.md files have the tutorials that are more up to
date compared to how they were (most of them had the tutorials completely
broken for a long while which was causing a lot of difficulties to the
newcomers who were trying to work with the packages).
4. The reason why they got so out of date traces back to the undue maintenance
burden of keeping separate images for each connector plugin. We hope that
with this simplification we can keep the documentation continuously up to
date since it will require less time do so.
5. Also deleted the ci.yaml container building jobs which were relevant to
the scope of this change so that we also save on CI resources, another
long-running project that's been in need of some attention from the maintainers.

Signed-off-by: Peter Somogyvari <[email protected]>
@petermetz petermetz force-pushed the fix-ghcr-connector-fabric-cve-2024-29415 branch from 4dd1ba5 to c6116b1 Compare July 15, 2024 16:03
@petermetz petermetz merged commit 24b5888 into hyperledger-cacti:main Jul 15, 2024
133 of 143 checks passed
@petermetz petermetz deleted the fix-ghcr-connector-fabric-cve-2024-29415 branch July 15, 2024 16:17
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.

3 participants