Wolfgang Walther and Wolfgang Walther
b49e3b1e5b
ci: Only run ARM-related jobs if related settings are present
...
This allows CI to properly run through in a fork, which doesn't have the SSH_ARM_xxx settings.
2024-02-24 17:27:01 +01:00
Wolfgang Walther
6caaee777b
nix: Simplify static.nix
...
The enable-executable-static flag is set by default, so doesn't make a difference.
The pkg-config improvement for libpq was merged upstream, so we can use the same
here already.
2024-02-24 15:38:02 +01:00
Wolfgang Walther
86b2e59f6f
chore: Add tested-with field to postgrest.cabal
...
This documents supported GHC versions. GHC 9.8.1 is currently commented
out to reflect the fact that PostgREST can't currently be built with it
straight from hackage - we still require some overrides in cabal.project
for that.
2024-02-24 14:07:55 +01:00
Wolfgang Walther
0738785d72
test: Improve dump-schema snapshot test formatting
...
Splitting the output into separate files and adding top-level newlines makes this
much better to read and understand when looking at diffs.
Inspired by #1699
2024-02-24 14:01:19 +01:00
Wolfgang Walther and Wolfgang Walther
2c2513b9cd
deps: Use libpq v16 for freebsd build
2024-02-24 13:46:05 +01:00
Wolfgang Walther and Wolfgang Walther
9314dede2d
ci: Build with GHC 9.8.2
2024-02-24 13:37:24 +01:00
Wolfgang Walther
ccc386cf38
nix: Add deadnix to postgrest-lint and remove dead nix code
2024-02-24 13:08:04 +01:00
Wolfgang Walther
caf0a70171
nix: Clarify pkg-config usage in static.nix a bit
...
This will make it easier to make the switch from pkgsCross.libpq to pkgsStatic.libpq,
once that is possible to build upstream - if ever.
2024-02-24 12:08:40 +01:00
Wolfgang Walther
22e8906c40
nix: Run faster tasks first in postgrest-lint
...
This avoid long waiting times when waiting for the result of shellcheck or actionlint.
2024-02-23 14:02:05 +01:00
Wolfgang Walther and Wolfgang Walther
0b3f6de015
ci: Merge docs-spellcheck and docs-dictcheck jobs
...
Both jobs run really quick, running them separate is just a waste of resources. Plus,
they are semantically closely related anyway.
2024-02-22 20:12:18 +01:00
Wolfgang Walther and Wolfgang Walther
c59736b902
ci: Rename release jobs for consistency
2024-02-22 20:12:18 +01:00
Wolfgang Walther and Wolfgang Walther
19423b0c0a
ci: Only run PR workflows when files have changed
2024-02-22 20:12:18 +01:00
Wolfgang Walther and Wolfgang Walther
e9abb64fc0
ci: Split Build workflow from CI workflow
2024-02-22 20:12:18 +01:00
Wolfgang Walther and Wolfgang Walther
57ef98a316
ci: Split Test workflow from CI workflow
2024-02-22 20:12:18 +01:00
Wolfgang Walther and Wolfgang Walther
31a3864f85
ci: Remove files from arm server immediately on non-release push
...
While this duplicates code a little bit, it makes it much simpler to refactor later on.
2024-02-22 20:12:18 +01:00
Wolfgang Walther and Wolfgang Walther
073280ad32
ci: Require docs job to pass before making a release
2024-02-22 20:12:18 +01:00
Wolfgang Walther and Wolfgang Walther
333f8cf592
ci: Cancel all workflows consistently in pull requests without blocking main
...
The previous setup would cause multiple commits on main to be stuck in a pending
state, waiting for the previous run to be finished.
The new group specification is taken from:
https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
This also adds the same settings for the docs workflow.
2024-02-22 20:12:18 +01:00
Wolfgang Walther and Wolfgang Walther
f9fdf666ad
ci: Use if without ${{ }} where possible
2024-02-22 20:12:18 +01:00
Wolfgang Walther and Wolfgang Walther
c54e0d3353
ci: Use actions/download-artifact instead of dawidd6/action-download-artifact
...
The "default" action now supports downloading from different workflow runs, too, so
we might as well use it.
2024-02-22 20:12:18 +01:00
steve-chavez
3a3601cbeb
feat: log schema cache load time
2024-02-21 18:16:37 -05:00
Wolfgang Walther and Wolfgang Walther
1a141c19df
nix: Add postgrest-docs-render to render latex documents
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
b8f35d880f
docs: Fix broken redirects in api.rst
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
791b86cbf6
docs: Add note about not support Stored Procedures
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/147
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
944b02fbb8
docs: Rename Stored Procedures to Functions consistently
...
This avoids confusing our RPCs with actual CREATE PROCEDURE, which we don't
support.
References https://github.com/PostgREST/postgrest-docs/issues/147
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
95b8751496
docs: Simplify SQL for user management how-tos
...
All those DROP IF EXISTS and CREATE IF NOT EXISTS etc. just give a lot more text to
read and understand. If in fact a user creates the same thing twice, they should be
able to understand the error message from postgres.
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
9b1ff2235a
docs: Simplify auth examples with OUT parameter
...
The jwt_token type was not created consistently in all examples, which can
be confusing when following those. To return an object with a single key
named token, it's enough to have an OUT parameter to the function.
Resolves https://github.com/PostgREST/postgrest-docs/issues/280
2024-02-21 09:40:11 +01:00
Steve Chavez and GitHub
7c6c056e92
refactor: make observation messages pure ( #3250 )
...
removes the observation messages from the Logger
2024-02-20 18:42:38 -05:00
Laurence Isla and GitHub
229bc77886
docs: using or across embedded resources
2024-02-20 17:15:42 -05:00
Wolfgang Walther and Wolfgang Walther
8a21a9c34e
fix: Dump media handlers and timezones with --dump-schema
...
Those were left out of the schema dump when the features were introduced, probably
because ByteString doesn't have a toJSON instance. Changing the type to Text solves
this easily.
Resolves #3237
2024-02-20 18:44:17 +01:00
Steve Chavez and GitHub
6d506df6f3
refactor: add observation module ( #3232 )
2024-02-20 12:29:33 -05:00
Taimoor Zaeem and GitHub
32e1900370
feat: dump schema cache through admin API ( #3233 )
2024-02-19 21:20:29 -05:00
Wolfgang Walther and Wolfgang Walther
fac7acafa3
chore: Add docs/_build to .gitignore again to allow switching to old release branches easily
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
645217333b
docs: Display version number more prominently
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/734
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
fcd29caecf
docs: Use code-block postgres consistently
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
553ac79d9b
docs: Add example on how to automatically store mimetype in files table
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/612
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
b2ad914435
docs: Improve introduction for datatypes how-to
...
Not all examples on this page are strictly using string representation, especially bytea.
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
8ee4e9f0bb
docs: Sort datatypes how-to alphabetically
...
The examples in this sections were in seemingly random order before.
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
8f2b6b1652
docs: Add hint about schema reloading with db-config=true
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/490
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
b1deb049c8
docs: Clarify behavior of jwt-aud and tokens without aud claim
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/479
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
51db5ce26f
docs: Add example for ordering by json field
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/364
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
e7dde2806c
docs: Change tutorials to use identity column instead of serial/sequence
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/311
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
4325a4f9d5
docs: Add links to resource embedding from insert/update/delete sections
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/277
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
77715dcabf
docs: Rename remaining instances of computed columns to computed fields
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/368
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
aaaf0572ce
docs: Remove deprecated auth0 features
...
As mentioned in https://github.com/PostgREST/postgrest/discussions/3088 rules and hooks are not
available to new tenants anymore, so the note is not helpful anymore.
Resolves #3088
Resolves https://github.com/PostgREST/postgrest-docs/issues/85
Resolves https://github.com/PostgREST/postgrest-docs/issues/715
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
500aad3360
docs: Clarify secret wording in tutorial 1
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/108
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
3d95c41115
docs: Remove note about risk of asymmetric keys for JWT auth
...
The obviously wrong statement is, that PostgREST does not support asymmetric keys, while it
does. Extending on this type of attack is not necessary, because it is in fact covered by
the paragraph before - reading the algorithm from the JWT header is the problem in that case,
too. We don't do that.
This leaves us with the sentence about how the chosen library is the most important part. While
that is correct, the hint about high quality libraries for use on the *client* side is mis-
leading: The important part here is the library we choose to implement PostgREST with, not the
client-side lib. Thus, removing the whole paragraph is the best thing to do here.
Resolves https://github.com/PostgREST/postgrest-docs/issues/123
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
6eaaa9aa9b
docs: Remove note about possible memory leak on alpine
...
We don't have any justification to add this hint anywhere.
Resolves https://github.com/PostgREST/postgrest-docs/issues/399
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
f33bccbcdb
docs: Use port 5432 in tutorial 0 to avoid connecting to the wrong server
...
Some users connect PostgREST to the wrong PostgreSQL instance - likely because they are
not even aware that another instance is running. By using the standard port 5432 instead
of 5433, we avoid this problem. The user will be made aware very early that they have
another postgresql instance running - and can solve the problem at this stage. If they
decide to change the port, they are much more likely to remember that in the later stages
of the tutorial, too.
Resolves https://github.com/PostgREST/postgrest-docs/issues/304
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
6c886b1291
docs: Update output in tutorials to latest version
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
0e7af7b77b
docs: Various formatting improvements
2024-02-19 21:54:15 +01:00