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

go installing doesn't work due to replace directive #490

Closed
jamietanna opened this issue Nov 23, 2023 · 9 comments · Fixed by #491
Closed

go installing doesn't work due to replace directive #490

jamietanna opened this issue Nov 23, 2023 · 9 comments · Fixed by #491

Comments

@jamietanna
Copy link
Contributor

When trying to do so, we see:

% go install github.com/StyraInc/regal@latest
go: downloading github.com/StyraInc/regal v0.13.0
go: github.com/StyraInc/regal@latest (in github.com/StyraInc/regal@v0.13.0):
        The go.mod file for the module providing named packages contains one or
        more replace directives. It must not contain directives that would cause
        it to be interpreted differently than if it were the main module.

I'd recently hit this on a personal project, and a solution that may work here is the following:

diff --git go.mod go.mod
index 1d307fd..3a86020 100644
--- go.mod
+++ go.mod
@@ -42,7 +42,8 @@ require (
 	github.com/prometheus/procfs v0.12.0 // indirect
 	github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect
 	github.com/rivo/uniseg v0.4.4 // indirect
-	github.com/sirupsen/logrus v1.9.3 // indirect
+	// wasip1 support isn't in a tagged version yet, remove for v1.9.4
+	github.com/sirupsen/logrus v1.9.4-0.20230606125235-dd1b4c2e81af // indirect
 	github.com/tchap/go-patricia/v2 v2.3.1 // indirect
 	github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
@@ -58,6 +59,3 @@ require (
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	sigs.k8s.io/yaml v1.4.0 // indirect
 )
-
-// wasip1 support isn't in a tagged version yet, remove for v1.9.4
-replace github.com/sirupsen/logrus => github.com/sirupsen/logrus v1.9.4-0.20230606125235-dd1b4c2e81af

Alternatively, we can wait until the logrus release is baked, but thought I'd flag that this could cause issues for folks.
@anderseknert
Copy link
Member

Thanks for raising that! The workaround seems fine to me — I just didn't know you could pin indirect dependencies like that. Will that be overwritten later when we upgrade OPA to the next version, or how does that work?

Also, I'm always curious to learn how Regal is used! Something secret, or can you tell me some about it? 😃

@anderseknert
Copy link
Member

Thinking about it, perhaps we could just use v1.9.3 for the logrus dependency, and include instructions for how to use replace in the Wasm build instructions? That's more of an experiment at this point in time, so if that breaks go get , I think it might not be worth having in main.

@jamietanna
Copy link
Contributor Author

Yeah in this case because we're taking a commit from the same repo, we can do so - if we wanted to use a fork, then we'd need a replace, or we'd need to update the fork's go.mod to point to their forked module path.

I think taking the proposed diff - pointing to that commit hash - works for now, and should unblock any go installs.

Will that be overwritten later when we upgrade OPA to the next version, or how does that work?

Depending on how you're doing the version bump, it should be straightforward. And i.e. Dependabot/Renovate/etc will notice when there's v1.9.4 of logrus and bump that accordingly.

@anderseknert
Copy link
Member

Since we don't really need a version above 1.9.3 for anything but the wasm experiment, I'd say let's use that for now. I can amend the instructions to the wasm section of the dev docs later. Would you want to submit a PR for the change?

Also, still curious to learn more about your Regal integration! 😊

@jamietanna jamietanna mentioned this issue Nov 24, 2023
Merged
jamietanna added a commit to jamietanna/regal that referenced this issue Nov 24, 2023
@jamietanna
Replace replace directive with direct version pinning
7355ab1 
As noted in StyraInc#490, by using a `replace` directive, we're unable to then `go
install` this project:

```
% go install github.com/StyraInc/regal@latest
go: downloading github.com/StyraInc/regal v0.13.0
go: github.com/StyraInc/regal@latest (in github.com/StyraInc/regal@v0.13.0):
        The go.mod file for the module providing named packages contains one or
        more replace directives. It must not contain directives that would cause
        it to be interpreted differently than if it were the main module.
```

Instead, we can replace this with a direct pinning to the commit we want to pull.

Closes StyraInc#490.
@jamietanna
Copy link
Contributor Author

Sure! I've raised #491 for it!

Also, I'm always curious to learn how Regal is used! Something secret, or can you tell me some about it? 😃

Certainly! I'm building dependency-management-data, a tool for understanding how you Open Source and internal dependencies are used. I'm in the process of adding Open Policy Agent support and as part of future work I'm looking at adding base + custom linting with regal - I've not done much with OPA but it's great to have a linter already available, and extensible 🚀

@anderseknert
Copy link
Member

That's a really cool use case! Do feel free to reach out when it's ready for a demo, as I'd love to try it out. Also happy to help promote it in our various channels 😃

@jamietanna
Copy link
Contributor Author

Thanks very much, will do!

@jamietanna
Copy link
Contributor Author

FYI I've just shipped regal support in DMD!

@anderseknert
Copy link
Member

Fantastic, @jamietanna! Sometime soon I'll either add an ADOPTERS.md file to the project, or a section in the README. Will make sure to include your project there 👍

srenatus pushed a commit to srenatus/regal that referenced this issue Nov 29, 2023
@jamietanna
Replace replace directive with direct version pinning (StyraInc#491)
ef28546 
As noted in StyraInc#490, by using a `replace` directive, we're unable to then `go
install` this project:

```
% go install github.com/StyraInc/regal@latest
go: downloading github.com/StyraInc/regal v0.13.0
go: github.com/StyraInc/regal@latest (in github.com/StyraInc/regal@v0.13.0):
        The go.mod file for the module providing named packages contains one or
        more replace directives. It must not contain directives that would cause
        it to be interpreted differently than if it were the main module.
```

Instead, we can replace this with a direct pinning to the commit we want to pull.

Closes StyraInc#490.
@jamietanna jamietanna mentioned this issue Sep 24, 2024
Closed
srenatus pushed a commit to srenatus/regal that referenced this issue Oct 1, 2024
@jamietanna @srenatus
Replace replace directive with direct version pinning (StyraInc#491)
43a7489 
As noted in StyraInc#490, by using a `replace` directive, we're unable to then `go
install` this project:

```
% go install github.com/StyraInc/regal@latest
go: downloading github.com/StyraInc/regal v0.13.0
go: github.com/StyraInc/regal@latest (in github.com/StyraInc/regal@v0.13.0):
        The go.mod file for the module providing named packages contains one or
        more replace directives. It must not contain directives that would cause
        it to be interpreted differently than if it were the main module.
```

Instead, we can replace this with a direct pinning to the commit we want to pull.

Closes StyraInc#490.
@jamietanna jamietanna mentioned this issue Oct 3, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Replace replace directive with direct version pinning jamietanna/regal
2 participants
@anderseknert @jamietanna