Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
greenpau committed Mar 26, 2024
1 parent a08a59a commit 4992f12
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,5 @@ changelog:
- '^update'
- '^github'
- '^release'
- '^chore:'
# - '^\w+\s+' # a hack to remove commit messages without colons thus don't correspond to a package
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,16 +67,16 @@ module github.com/greenpau/caddy-security
go 1.21
require (
github.com/greenpau/go-authcrunch v1.1.2
github.com/greenpau/go-authcrunch v1.1.3
)
replace github.com/greenpau/go-authcrunch v1.1.2 => /home/greenpau/dev/go/src/github.com/greenpau/go-authcrunch
replace github.com/greenpau/go-authcrunch v1.1.3 => /home/greenpau/dev/go/src/github.com/greenpau/go-authcrunch
```

Alternatively:

```bash
go mod edit -replace github.com/greenpau/go-authcrunch@v1.1.2=/home/greenpau/dev/go/src/github.com/greenpau/go-authcrunch@v1.0.48
go mod edit -replace github.com/greenpau/go-authcrunch@v1.1.3=/home/greenpau/dev/go/src/github.com/greenpau/go-authcrunch@v1.0.48
```

Then, modify `Makefile` such that that replacement passes to `xcaddy` builder:
Expand All @@ -85,7 +85,7 @@ Then, modify `Makefile` such that that replacement passes to `xcaddy` builder:
@mkdir -p ../xcaddy-$(PLUGIN_NAME) && cd ../xcaddy-$(PLUGIN_NAME) && \
xcaddy build $(CADDY_VERSION) --output ../$(PLUGIN_NAME)/bin/caddy \
--with github.com/greenpau/caddy-security@$(LATEST_GIT_COMMIT)=$(BUILD_DIR) \
--with github.com/greenpau/go-authcrunch@v1.1.2=/home/greenpau/dev/go/src/github.com/greenpau/go-authcrunch
--with github.com/greenpau/go-authcrunch@v1.1.3=/home/greenpau/dev/go/src/github.com/greenpau/go-authcrunch
```

Once all the necessary packages are installed, you should be ready to compile
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ devbuild:
xcaddy build $(CADDY_VERSION) --output ../$(PLUGIN_NAME)/bin/authcrunch \
--with github.com/greenpau/caddy-security@$(LATEST_GIT_COMMIT)=$(BUILD_DIR) \
--with github.com/greenpau/caddy-trace@latest \
--with github.com/greenpau/go-authcrunch@v1.1.2=/home/greenpau/dev/go/src/github.com/greenpau/go-authcrunch
--with github.com/greenpau/go-authcrunch@v1.1.3=/home/greenpau/dev/go/src/github.com/greenpau/go-authcrunch
@go build -v -o ./bin/authcrunch cmd/authcrunch/main.go;
@./bin/authcrunch version
@echo "$@: complete"
Expand Down

0 comments on commit 4992f12

Please sign in to comment.