Skip to content

Commit 145990a

Browse files
authored
Refactor dsig extension (#7)
* overhaul to dsig extension from jwx extension * update README for dsig rename * add goreleaser workflow
1 parent 5b8ab62 commit 145990a

2 files changed

Lines changed: 38 additions & 6 deletions

File tree

.github/workflows/release.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*"
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
goreleaser:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
17+
with:
18+
fetch-depth: 0
19+
20+
- name: Install Go
21+
uses: actions/setup-go@4b73464bb391d4059bd26b0524d20df3927bd417 # v6.3.0
22+
with:
23+
go-version-file: go.mod
24+
cache: false
25+
26+
- name: Run GoReleaser
27+
uses: goreleaser/goreleaser-action@ec59f474b9834571250b370d4735c50f8e2d1e29 # v7.0.0
28+
with:
29+
version: latest
30+
args: release --clean
31+
env:
32+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# github.com/lestrrat-go/jwx-circl-ed448 [![Go Reference](https://pkg.go.dev/badge/github.com/lestrrat-go/jwx-circl-ed448.svg)](https://pkg.go.dev/github.com/lestrrat-go/jwx-circl-ed448)
1+
# github.com/lestrrat-go/dsig-circl-ed448 [![Go Reference](https://pkg.go.dev/badge/github.com/lestrrat-go/dsig-circl-ed448.svg)](https://pkg.go.dev/github.com/lestrrat-go/dsig-circl-ed448)
22

3-
Ed448 signing/verification and JWK support for [github.com/lestrrat-go/jwx/v3](https://github.com/lestrrat-go/jwx), powered by [cloudflare/circl](https://github.com/cloudflare/circl).
3+
Ed448 signing/verification support for [github.com/lestrrat-go/dsig](https://github.com/lestrrat-go/dsig), powered by [cloudflare/circl](https://github.com/cloudflare/circl).
44

55
# Why a separate module?
66

7-
Go's standard library does not include Ed448 support. The only viable implementation comes from `github.com/cloudflare/circl`, which is a large dependency. Rather than forcing every `jwx` user to pull in `circl`, Ed448 support is provided as an opt-in companion module.
7+
Go's standard library does not include Ed448 support. The only viable implementation comes from `github.com/cloudflare/circl`, which is a large dependency. Rather than forcing every `dsig` user to pull in `circl`, Ed448 support is provided as an opt-in companion module.
88

99
# Synopsis
1010

11-
Import this package for its side effects to register Ed448 with `jwx`:
11+
Import this package for its side effects to register Ed448 with `dsig`:
1212

1313
<!-- INCLUDE(example_test.go) -->
1414
```go
@@ -51,11 +51,11 @@ func Example() {
5151
// signature verified
5252
}
5353
```
54-
source: [example_test.go](https://github.com/lestrrat-go/jwx-circl-ed448/blob/main/example_test.go)
54+
source: [example_test.go](https://github.com/lestrrat-go/dsig-circl-ed448/blob/main/example_test.go)
5555
<!-- END INCLUDE -->
5656

5757
# Installation
5858

5959
```
60-
go get github.com/lestrrat-go/jwx-circl-ed448
60+
go get github.com/lestrrat-go/dsig-circl-ed448
6161
```

0 commit comments

Comments
 (0)