squawk-cli 1.5.5 → 1.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -13
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -173,13 +173,13 @@ See the ["GitHub Integration" docs](https://squawkhq.com/docs/github_app) for mo
173
173
  Integrate Squawk into Git workflow with [pre-commit](https://pre-commit.com/). Add the following
174
174
  to your project's `.pre-commit-config.yaml`:
175
175
 
176
- ```
176
+ ```yaml
177
177
  repos:
178
178
  - repo: https://github.com/sbdchd/squawk
179
179
  rev: v0.10.0
180
180
  hooks:
181
- - id: squawk
182
- files: path/to/postres/migrations/written/in/sql
181
+ - id: squawk
182
+ files: path/to/postgres/migrations/written/in/sql
183
183
  ```
184
184
 
185
185
  Note the `files` parameter as it specifies the location of the files to be linted.
@@ -197,6 +197,7 @@ Note the `files` parameter as it specifies the location of the files to be linte
197
197
  - <https://github.com/AdmTal/PostgreSQL-Query-Lock-Explainer>
198
198
  - <https://github.com/stripe/pg-schema-diff>
199
199
  - <https://github.com/kristiandupont/schemalint>
200
+ - <https://github.com/supabase-community/postgres-language-server>
200
201
 
201
202
  ## related blog posts / SE Posts / PG Docs
202
203
 
@@ -241,22 +242,20 @@ s/new-rule 'prefer big serial'
241
242
 
242
243
  ### releasing a new version
243
244
 
244
- 1. update the CHANGELOG.md and bump version in the cli `Cargo.toml`, ensure the
245
- lock file is updated, and update `package.json` and commit the changes
245
+ 1. Update the `CHANGELOG.md`
246
+
247
+ Include a description of any fixes / additions. Make sure to include the PR numbers and credit the authors.
248
+
249
+ 2. Run `s/update-version`
246
250
 
247
251
  ```bash
248
- # update version in Cargo.toml files and package.json to 4.5.3
252
+ # update version in cli/Cargo.toml, package.json, flake.nix to 4.5.3
249
253
  s/update-version 4.5.3
250
254
  ```
251
255
 
252
- 2. create a new release on github - CI will attach the binaries automatically
253
- 3. wait for build artifacts to be attached to release.
254
- 4. login to `npm` and publish new version.
256
+ 3. Create a new release on GitHub
255
257
 
256
- ```bash
257
- npm login
258
- npm publish
259
- ```
258
+ Use the text and version from the `CHANGELOG.md`
260
259
 
261
260
  ### algolia
262
261
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squawk-cli",
3
- "version": "1.5.5",
3
+ "version": "1.6.1",
4
4
  "description": "linter for PostgreSQL, focused on migrations",
5
5
  "repository": "git@github.com:sbdchd/squawk.git",
6
6
  "author": "Steve Dignam <steve@dignam.xyz>",