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

Add --replace for dependency replacement #186

Merged
merged 3 commits into from
May 29, 2024
Merged

Add --replace for dependency replacement #186

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a93ed7
add --replace to change dependency version
WeidiDeng May 29, 2024
d88002d
deduplicate codes
WeidiDeng May 29, 2024
84a68ff
update README.md
WeidiDeng May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ Syntax:
$ xcaddy build [<caddy_version>]
[--output <file>]
[--with <module[@version][=replacement]>...]
[--replace <module[@version]=replacement>...]
[--embed <[alias]:path/to/dir>...]
```

Expand All @@ -73,6 +74,7 @@ $ xcaddy build [<caddy_version>]

- `--output` changes the output file.
- `--with` can be used multiple times to add plugins by specifying the Go module name and optionally its version, similar to `go get`. Module name is required, but specific version and/or local replacement are optional.
- `--replace` can be used multiple times to replace dependencies to specific forks or local replacements. Useful in development environment to fix bugs in dependencies.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- `--replace` can be used multiple times to replace dependencies to specific forks or local replacements. Useful in development environment to fix bugs in dependencies.
- `--replace` can be used multiple times to replace dependencies to specific forks or local replacements. Useful in development environment when trying to fix bugs in Caddy's dependencies, via a fork or local checkout.

Copy link
Member

Choose a reason for hiding this comment

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

What about "--replace is like --with, but does not add a blank import to the code; it only writes a replace directive to go.mod, which is useful when developing on Caddy's dependencies that aren't Caddy modules." ?

- `--embed` can be used multiple times to embed directories into the built Caddy executable. The directory can be prefixed with a custom alias and a colon `:` to use it with the `root` directive and sub-directive.

Examples:
Expand All @@ -97,14 +99,14 @@ $ xcaddy build \
--with github.com/caddyserver/ntlm-transport@v0.1.1=../../my-fork
```

You can even replace Caddy core using the `--with` flag:
You can even replace Caddy core using the `--replace` flag:

```
$ xcaddy build \
--with github.com/caddyserver/caddy/v2=../../my-caddy-fork
--replace github.com/caddyserver/caddy/v2=../../my-caddy-fork

$ xcaddy build \
--with github.com/caddyserver/caddy/v2=github.com/my-user/caddy/v2@some-branch
--replace github.com/caddyserver/caddy/v2=github.com/my-user/caddy/v2@some-branch
```
Comment on lines +102 to 110
Copy link
Member

Choose a reason for hiding this comment

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

Well, technically it still works with --with cause we check for that. I think here it should show an example replacing a dep like x/net as you're doing, it's a better example.


This allows you to hack on Caddy core (and optionally plug in extra modules at the same time!) with relative ease.
Expand Down
Loading