Skip to content

Commit 2328c81

Browse files
docs: Add release notes for v1.25.0 (#3100)
* docs: Add release notes for v1.25.0 * Update docs/howto/push.md Co-authored-by: Andrew Benton <[email protected]>
1 parent 874bfc2 commit 2328c81

File tree

3 files changed

+121
-2
lines changed

3 files changed

+121
-2
lines changed

docs/howto/push.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,17 @@ The output is the files `sqlc` would have sent without the `--dry-run` flag.
4545
Once you're ready to push, remove the `--dry-run` flag.
4646

4747
```shell
48-
sqlc push
48+
$ sqlc push
49+
```
50+
51+
### Tags
52+
53+
You can provide tags to associate with a push, primarily as a convenient reference when using `sqlc verify` with the `against` argument.
54+
55+
Tags only refer to a single push, so if you pass an existing tag to `push` it will overwrite the previous reference.
56+
57+
```shell
58+
$ sqlc push --tag main
4959
```
5060

5161
### Annotations

docs/howto/verify.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ environment variable. You can create an auth token via the [dashboard](https://d
8181
export SQLC_AUTH_TOKEN=sqlc_xxxxxxxx
8282
```
8383

84-
8584
## Expected workflow
8685

8786
Using `sqlc verify` requires pushing your queries and schema to sqlc Cloud. When
@@ -90,5 +89,21 @@ queries as well. For example, we run `sqlc push` after any change has been
9089
merged into our `main` branch on Github, as we deploy every commit to
9190
production.
9291

92+
```shell
93+
$ sqlc push --tag main
94+
```
95+
9396
Locally or in pull requests, run `sqlc verify` to check that existing queries
9497
continue to work with your current database schema.
98+
99+
```shell
100+
$ sqlc verify --against main
101+
```
102+
103+
## Picking a tag
104+
105+
Without an `against` argument, `verify` will run its analysis of the provided schema using your most-recently pushed queries. We suggest using the `against` argument to explicitly select a set of queries for comparison.
106+
107+
```shell
108+
$ sqlc verify --against [tag]
109+
```

docs/reference/changelog.md

+94
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,100 @@
11
# Changelog
22
All notable changes to this project will be documented in this file.
33

4+
(v1-25-0)=
5+
## [1.25.0](https://github.com/sqlc-dev/sqlc/releases/tag/v1.25.0)
6+
Released 2024-01-03
7+
8+
### Release notes
9+
10+
#### Add tags to push and verify
11+
12+
You can add tags when [pushing](../howto/push.md) schema and queries to [sqlc Cloud](https://dashboard.sqlc.dev). Tags operate like git tags, meaning you can overwrite previously-pushed tag values. We suggest tagging pushes to associate them with something relevant from your environment, e.g. a git tag or branch name.
13+
14+
```
15+
$ sqlc push --tag v1.0.0
16+
```
17+
18+
Once you've created a tag, you can refer to it when [verifying](../howto/verify.md) changes, allowing you
19+
to compare the existing schema against a known set of previous queries.
20+
21+
```
22+
$ sqlc verify --against v1.0.0
23+
```
24+
25+
#### C-ya, `cgo`
26+
27+
Over the last month, we've switched out a few different modules to remove our reliance on [cgo](https://go.dev/blog/cgo). Previously, we needed cgo for three separate functions:
28+
29+
- Parsing PostgreSQL queries with [pganalyze/pg_query_go](https://github.com/pganalyze/pg_query_go)
30+
- Running SQLite databases with [mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
31+
- Executing WASM / WASI code with [bytecodealliance/wasmtime-go](https://github.com/bytecodealliance/wasmtime-go)
32+
33+
With the help of the community, we found cgo-free alternatives for each module:
34+
35+
- Parsing PostgreSQL queries, now using [wasilibs/go-pgquery](https://github.com/wasilibs/go-pgquery)
36+
- Running SQLite databases, now using [modernc.org/sqlite](https://gitlab.com/cznic/sqlite)
37+
- Executing WASM / WASI code, now using [tetratelabs/wazero](https://github.com/tetratelabs/wazero)
38+
39+
For the first time, Windows users can enjoy full PostgreSQL support without using [WSL](https://learn.microsoft.com/en-us/windows/wsl/about). It's a Christmas miracle!
40+
41+
If you run into any issues with the updated dependencies, please [open an issue](https://github.com/sqlc-dev/sqlc/issues).
42+
43+
### Changes
44+
45+
#### Bug Fixes
46+
47+
- (codegen) Wrong yaml annotation in go codegen options for output_querier_file_name (#3006)
48+
- (codegen) Use derived ArrayDims instead of deprecated attndims (#3032)
49+
- (codegen) Take the maximum array dimensions (#3034)
50+
- (compiler) Skip analysis of queries without a `name` annotation (#3072)
51+
- (codegen/golang) Don't import `"strings"` for `sqlc.slice()` with pgx (#3073)
52+
53+
### Documentation
54+
55+
- Add name to query set configuration (#3011)
56+
- Add a sidebar link for `push`, add Go plugin link (#3023)
57+
- Update banner for sqlc-gen-typescript (#3036)
58+
- Add strict_order_by in doc (#3044)
59+
- Re-order the migration tools list (#3064)
60+
61+
### Features
62+
63+
- (analyzer) Return zero values when encountering unexpected ast nodes (#3069)
64+
- (codegen/go) add omit_sqlc_version to Go code generation (#3019)
65+
- (codgen/go) Add `emit_sql_as_comment` option to Go code plugin (#2735)
66+
- (plugins) Use wazero instead of wasmtime (#3042)
67+
- (push) Add tag support (#3074)
68+
- (sqlite) Support emit_pointers_for_null_types (#3026)
69+
70+
### Testing
71+
72+
- (endtoend) Enable for more build targets (#3041)
73+
- (endtoend) Run MySQL and PostgreSQL locally on the runner (#3095)
74+
- (typescript) Test against sqlc-gen-typescript (#3046)
75+
- Add tests for omit_sqlc_version (#3020)
76+
- Split schema and query for test (#3094)
77+
78+
### Build
79+
80+
- (deps) Bump idna from 3.4 to 3.6 in /docs (#3010)
81+
- (deps) Bump sphinx-rtd-theme from 1.3.0 to 2.0.0 in /docs (#3016)
82+
- (deps) Bump golang from 1.21.4 to 1.21.5 (#3043)
83+
- (deps) Bump actions/setup-go from 4 to 5 (#3047)
84+
- (deps) Bump github.com/jackc/pgx/v5 from 5.5.0 to 5.5.1 (#3050)
85+
- (deps) Upgrade to latest version of github.com/wasilibs/go-pgquery (#3052)
86+
- (deps) Bump google.golang.org/grpc from 1.59.0 to 1.60.0 (#3053)
87+
- (deps) Bump babel from 2.13.1 to 2.14.0 in /docs (#3055)
88+
- (deps) Bump actions/upload-artifact from 3 to 4 (#3061)
89+
- (deps) Bump modernc.org/sqlite from 1.27.0 to 1.28.0 (#3062)
90+
- (deps) Bump golang.org/x/crypto from 0.14.0 to 0.17.0 (#3068)
91+
- (deps) Bump google.golang.org/grpc from 1.60.0 to 1.60.1 (#3070)
92+
- (deps) Bump google.golang.org/protobuf from 1.31.0 to 1.32.0 (#3079)
93+
- (deps) Bump github.com/tetratelabs/wazero from 1.5.0 to 1.6.0 (#3096)
94+
- (sqlite) Update to antlr 4.13.1 (#3086)
95+
- (sqlite) Disable modernc for WASM (#3048)
96+
- (sqlite) Switch from mattn/go-sqlite3 to modernc.org/sqlite (#3040)
97+
498
(v1-24-0)=
599
## [1.24.0](https://github.com/sqlc-dev/sqlc/releases/tag/v1.24.0)
6100
Released 2023-11-22

0 commit comments

Comments
 (0)