jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

nix: fix typos in README

Browse Source
This commit is contained in:
omahs
2023-11-08 11:43:42 -05:00
committed by GitHub
parent 99b705d44f
commit f10d4139fe
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
nix/README.md
+4 -4
View File
@@ -91,7 +91,7 @@ Some additional modules like `memory`, `docker` and `release`
have large dependencies that would need to be built before the shell becomes have large dependencies that would need to be built before the shell becomes
available, which could take an especially long time if the cachix binary cache available, which could take an especially long time if the cachix binary cache
is not used. You can activate those by passing a flag to `nix-shell` with is not used. You can activate those by passing a flag to `nix-shell` with
`nix-shell --arg <module> true`. This will make the respective utilites available: `nix-shell --arg <module> true`. This will make the respective utilities available:
```bash ```bash
$ nix-shell --arg memory true $ nix-shell --arg memory true
@@ -113,7 +113,7 @@ postgrest-test-memory
Note that `postgrest-test-memory` is now also available. Note that `postgrest-test-memory` is now also available.
To run one-off commands, you can also use `nix-shell --run <command>`, which To run one-off commands, you can also use `nix-shell --run <command>`, which
will lauch the Nix shell, run that one command and exit. Note that the tab will launch the Nix shell, run that one command and exit. Note that the tab
completion will not work with `nix-shell --run`, as Nix has yet to evaluate completion will not work with `nix-shell --run`, as Nix has yet to evaluate
our Nix expressions to see which utilities are available. our Nix expressions to see which utilities are available.
@@ -246,7 +246,7 @@ $ nix-shell --run postgrest-style
``` ```
There is also `postgrest-style-check` that exits with a non-zero exit code if There is also `postgrest-style-check` that exits with a non-zero exit code if
the check resulted in any uncommited changes. It's mostly useful for CI. the check resulted in any uncommitted changes. It's mostly useful for CI.
## General development tools ## General development tools
@@ -309,7 +309,7 @@ version.
### `shell.nix` ### `shell.nix`
[`shell.nix`](../shell.nix) defines an environment in which PostgREST can be [`shell.nix`](../shell.nix) defines an environment in which PostgREST can be
built and developed. It extends the build enviroment from our `postgrest` built and developed. It extends the build environment from our `postgrest`
attribute with useful utilities that will be put on the PATH in `nix-shell`. attribute with useful utilities that will be put on the PATH in `nix-shell`.
### `nix/overlays` ### `nix/overlays`
nix/UPGRADE.md
+1 -1
View File
@@ -74,7 +74,7 @@ required to avoid build timeouts in CI.
You'll need to set the `CACHIX_SIGNING_KEY` before proceeding, e.g. by creating You'll need to set the `CACHIX_SIGNING_KEY` before proceeding, e.g. by creating
a file containing `export CACHIX_SIGNING_KEY=...` and sourcing that file, which a file containing `export CACHIX_SIGNING_KEY=...` and sourcing that file, which
avoids having the secret in you shell history. avoids having the secret in your shell history.
To push all new artifacts to Cachix, run: To push all new artifacts to Cachix, run:
nix/tools/release/docker-hub-full-description.md
+2 -2
View File
@@ -48,13 +48,13 @@ To learn how to use this container, see the [PostgREST Docker
documentation](https://postgrest.org/en/stable/install.html#docker). documentation](https://postgrest.org/en/stable/install.html#docker).
You can configure the PostgREST image by setting You can configure the PostgREST image by setting
[enviroment variables](https://postgrest.org/en/stable/configuration.html). [environment variables](https://postgrest.org/en/stable/configuration.html).
# How this image is built # How this image is built
The image is built from scratch using The image is built from scratch using
[Nix](https://nixos.org/nixpkgs/manual/#sec-pkgs-dockerTools) instead of a [Nix](https://nixos.org/nixpkgs/manual/#sec-pkgs-dockerTools) instead of a
`Dockerfile`, which yields a higly secure and optimized image. This is also why `Dockerfile`, which yields a highly secure and optimized image. This is also why
no commands are listed in the image history. See the [PostgREST no commands are listed in the image history. See the [PostgREST
respository](https://github.com/PostgREST/postgrest/tree/main/nix/tools/docker) for respository](https://github.com/PostgREST/postgrest/tree/main/nix/tools/docker) for
details on the build process and how to inspect the image. details on the build process and how to inspect the image.