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: Remove go modules under apis directory #12764

Merged
merged 2 commits into from
Aug 22, 2023
Merged

Conversation

travisn
Copy link
Member

@travisn travisn commented Aug 21, 2023

Description of your changes:
The go package dependencies (go.mod and go.sum) were created under the pkg/apis directory to simplify the dependencies for other projects referencing the rook repo. The downside is that the dependabot can no longer open a working and valid PR since the bot is not aware of the go.mod and go.sum in the apis directory.

Since the reduction of dependencies for vault in #12455, the list of extra dependencies is not quite so extensive. We are putting effort into shrinking the dependency list instead of using the modules files in the apis subdirectory. See also #12663.

Note that #12419 updated the dependencies for the latest controller runtime which also increased the size of the modules list in the pkgs subdirectory, which means the difference in dependencies in the pkgs subdirectory is no longer signficant anyway.

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Skip Tests for Docs: If this is only a documentation change, add the label skip-ci on the PR.
  • Reviewed the developer guide on Submitting a Pull Request
  • Pending release notes updated with breaking and/or notable changes for the next minor release.
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.

The go package dependencies (go.mod and go.sum) were created
under the pkg/apis directory to simplify the dependencies for
other projects referencing the rook repo. The downside is that
the dependabot can no longer open a working and valid PR since
the bot is not aware of the go.mod and go.sum in the apis directory.

Since the reduction of dependencies for vault in rook#12455,
the list of extra dependencies is not quite so extensive.
We are putting effort into shrinking the dependency list instead
of using the modules files in the apis subdirectory.

Note that rook#12419 updated the dependencies for the latest controller
runtime which also increased the size of the modules
list in the pkgs subdirectory, which means the difference
in dependencies in the pkgs subdirectory is no longer
signficant anyway.

Signed-off-by: travisn <tnielsen@redhat.com>
Run make go.mod.update to update the go modules to
the latest references.

Signed-off-by: travisn <tnielsen@redhat.com>
Copy link
Member

@BlaineEXE BlaineEXE left a comment

Choose a reason for hiding this comment

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

So glad to have dependabot working again for keeping our modules up to date for security 👏

@cp -a go.sum pkg/apis/go.sum
@cat go.mod | sed -e 's|^module github.com/rook/rook|module github.com/rook/rook/pkg/apis|' \
-e '\:^replace github.com/rook/rook/pkg/apis => ./pkg/apis:d' > pkg/apis/go.mod
@echo === ensuring APIs modules are tidied
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

It looks like the "APIs modules" was not present, but "ensuring modules" was. IMO, this is pretty minor anyway

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants