Skip to content

Commit 94834ae

Browse files
docs: update (#7)
1 parent a2f599e commit 94834ae

File tree

2 files changed

+40
-3
lines changed

2 files changed

+40
-3
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.idea
2-
/build
2+
/build
3+
/bin

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,10 @@ go install github.com/kevinmichaelchen/graphql-schema-picker@latest
3939
### Usage
4040

4141
```shell
42-
go run cmd/graphql-schema-picker/main.go \
42+
graphql-schema-picker \
4343
--debug \
4444
pick \
45+
--output output.sdl.graphqls \
4546
--sdl-file examples/hasura.sdl.graphqls \
4647
--definitions Aircrafts
4748
```
@@ -52,4 +53,39 @@ go run cmd/graphql-schema-picker/main.go \
5253
- https://github.com/kesne/graphql-schema-subset
5354
- https://github.com/xometry/graphql-code-generator-subset-plugin
5455
- https://the-guild.dev/graphql/tools/docs/api/classes/wrap_src.pruneschema
55-
- https://pothos-graphql.dev/docs/plugins/sub-graph
56+
- https://pothos-graphql.dev/docs/plugins/sub-graph
57+
58+
## Contributing
59+
60+
### Building
61+
62+
```shell
63+
go run cmd/graphql-schema-picker/main.go \
64+
--debug \
65+
pick \
66+
--output output.sdl.graphqls \
67+
--sdl-file examples/hasura.sdl.graphqls \
68+
--definitions Aircrafts
69+
```
70+
71+
### Releasing
72+
73+
Create tags with `xc tag` and push them with `git push --tags`.
74+
75+
## Tasks
76+
77+
### build
78+
79+
Builds the Go program into a local binary.
80+
81+
```shell
82+
go build -v -trimpath -ldflags="-s -w" -o ./bin/graphql-schema-picker ./cmd/graphql-schema-picker
83+
```
84+
85+
### tag
86+
87+
Create a new Git tag
88+
89+
```shell
90+
git tag -a $(svu next) -m "$(svu next)"
91+
```

0 commit comments

Comments
 (0)