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

Starting v3 release for plugin developers. #1240

Merged
merged 1 commit into from
Jun 23, 2019

Conversation

monopole
Copy link
Contributor

@monopole monopole commented Jun 23, 2019

Starting v3 release for plugin developers.

Per this Go modules doc a repo or branch that's
already tagged v2 or higher should increment the major
version (e.g. go to v3) when releasing their first Go
module-based packages. Since v2.0.3 is already
tagged, go mod used in the context of a Go plugin
developer will default to that version, and 2.0.3
is incompatible with plugins. The fix for this is to
start a v3 series.

At the moment, the kustomize repo has these top level
packages in the sigs.k8s.io/kustomize module:

  • cmd - holds main program for kustomize

    Conceivably someone can depend on this
    package for integration tests.

  • internal - intentionally unreleased subpackages

  • k8sdeps - an adapter wrapping k8s dependencies

    This exists only for use in pre-Go-modules kustomize-into-kubectl
    integration and won't live much longer (as everything involved is
    switching to Go modules).

  • pkg - kustomize packages for export

    This should shrink in later versions, since
    the surface area is too large, containing
    sub-packages that should be in 'internal'.

  • plugin - holds main programs for plugins

This PR changes the top level go.mod file from

module sigs.k8s.io/kustomize

to

module sigs.k8s.io/kustomize/v3

and adjusts all import statements to
reflect the change.

After this, externally developed plugins should be able to depend
on v3 (via their own go.mod file) and get the right immediate and transitive deps.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 23, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: monopole

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 23, 2019
@monopole monopole requested review from sethpollack and removed request for justinsb and Liujingfang1 June 23, 2019 21:02
@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jun 23, 2019
Copy link
Contributor

@sethpollack sethpollack left a comment

Choose a reason for hiding this comment

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

lgtm

[doc]: https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher

Per this Go modules [doc] a repo or branch that's
already tagged v2 or higher should increment the major
version (e.g. go to v3) when releasing their first Go
module-based packages.

At the moment, the kustomize repo has these top level
packages in the sigs.k8s.io/kustomize module:

 - `cmd` - holds main program for kustomize

	 Conceivably someone can depend on this
	 package for integration tests.

 - `internal` - intentionally unreleased subpackages

 - `k8sdeps` - an adapter wrapping k8s dependencies

	 This exists only for use in pre-Go-modules kustomize-into-kubectl
	 integration and won't live much longer (as everything involved is
	 switching to Go modules).

 - `pkg` - kustomize packages for export

	 This should shrink in later versions, since
	 the surface area is too large, containing
	 sub-packages that should be in 'internal'.

 - `plugin` - holds main programs for plugins

This PR changes the top level go.mod file from

```
module sigs.k8s.io/kustomize
```

to

```
module sigs.k8s.io/kustomize/v3
```

and adjusts all import statements to
reflect the change.
@monopole monopole merged commit b878cd0 into kubernetes-sigs:master Jun 23, 2019
@monopole monopole deleted the v3 branch June 28, 2019 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants