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.

Sign up for GitHub

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

Jump to bottom

Review and correct internal/ vs pkg/ code location #80

Closed
dtrudg opened this issue Jun 3, 2021 · 2 comments
Closed

Review and correct internal/ vs pkg/ code location #80

dtrudg opened this issue Jun 3, 2021 · 2 comments
Labels
roadmap Features / changes that are scheduled to be implemented techdebt
Milestone
SingularityCE 4.0.0

Comments

@dtrudg
Copy link
Member

dtrudg commented Jun 3, 2021 •
edited
Loading

Type of issue
technical debt

Description of issue
Various portions of code in public pkg/ areas are not likely to be stable over time at present. This should be worked out so that it is possible to move toward the expectation that 3rd parties can use pkg/ functions with some stability, and as a stepping stone toward Go module semantic versioning conformance.
@dtrudg dtrudg added the techdebt label Jun 3, 2021
@dtrudg dtrudg added this to the SingularityCE 4+ milestone Jun 3, 2021
@dtrudg dtrudg added the roadmap Features / changes that are scheduled to be implemented label Jul 2, 2021
@dtrudg dtrudg mentioned this issue Jul 23, 2021
Closed
@dtrudg dtrudg mentioned this issue Aug 1, 2022
Closed
@dtrudg dtrudg mentioned this issue Jun 29, 2023
Closed
@dtrudg
Copy link
Member Author

dtrudg commented Jul 25, 2023 •
edited
Loading

Need to move from pkg -> internal/pkg:

Need to tidy up:

  • pkg/ociruntime - only some constants used in e2e tests.

Need to remove:

  • internal/pkg/util/exec - unused code

Candidates to move from internal/pkg -> pkg

These are stable enough, but might not be interesting / valuable to make available.

  • internal/pkg/cgroups
  • internal/pkg/fakeroot
  • internal/pkg/signature
  • internal/pkg/fs (helper.go)
  • internal/pkg/util/machine
  • internal/pkg/util/passwdfile
  • internal/pkg/util/priv
  • internal/pkg/util/signal

This was referenced Jul 25, 2023
Merged
Merged
dtrudg added a commit that referenced this issue Jul 25, 2023
@dtrudg
chore: remove pkg/ociruntime
2149052 
As we are bumping to a new major version, we can remove pkg/ociruntime
at this point.

We don't have our own implementation of an OCI runtime since 3.10.0
and the code here is only used in e2e-tests.

It's better to use the upstream oci runtime-spec structs / constants
instead, in those tests.

Part of #80
dtrudg added a commit that referenced this issue Jul 26, 2023
@dtrudg
chore: move pkg/sypgp to internal/pkg/sypgp
409c8c7 
The sypgp package isn't really suitable for external consumption.

Key handling / management, including sygpg, is intended to go through
some refactoring in the near to mid future.

Move to internal at this point, while we are at a major version bump.

Part of #80
@dtrudg
Copy link
Member Author

dtrudg commented Jul 26, 2023

The required changes, from pkg -> internal/pkg, and removals, have been completed.

Consideration of exposing stable parts of internal/pkg can be tackled when time permits. Adding functionality with breakage is okay in a minor semver bump.

@dtrudg dtrudg closed this as completed Jul 26, 2023
This was referenced Nov 10, 2023
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
roadmap Features / changes that are scheduled to be implemented techdebt
Projects
None yet
Milestone
SingularityCE 4.0.0
Development

No branches or pull requests
1 participant
@dtrudg