1
1
mirror of https://github.com/anoma/juvix.git synced 2024-12-15 10:03:22 +03:00
juvix/docker/README.md
Jonathan Cubides 22ba8f15fd
Add new README and md files (#1904)
In this PR, I have updated the README file to reflect the new goals of
the project and highlight related products to Juvix. The ORG files have
been replaced with Markdown for better readability and maintainability.
Additionally, I have added a couple of files to fine-tune the mdbook
settings. These changes, I believe, will make it easier for users to
understand and contribute to the project.🤞

- Closes #1878
- New pre-commit hook to format md, yaml, js, CSS files.

To check the website generation, I have deployed the result here:
Work in progress.

- https://jonaprieto.github.io/juvix
- https://github.com/jonaprieto/juvix

---------

Co-authored-by: Paul Cadman <pcadman@gmail.com>
Co-authored-by: Christopher Goes <cwgoes@pluranimity.org>
Co-authored-by: Jan Mas Rovira <janmasrovira@gmail.com>
2023-03-21 20:01:48 +01:00

47 lines
1.2 KiB
Markdown

# The GHC alpine image
We need this image to workaround an issue with the official GHC alpine binary,
see https://gitlab.haskell.org/ghc/ghc/-/issues/20266
We use this image to make static linux binaries.
## Building the image
The tag of the image should be prefixed by the location of the GitHub docker
repository that you're pushing to. In this case the repository is `
ghcr.io/paulcadman`.
```shell
docker build -t ghcr.io/paulcadman/ghc-alpine:9.2.6 -f Dockerfile-ghc-alpine-9.2.6 .
```
## Authenticating with the GitHub Docker repository
First create a classic personal access token with `repo` and `write:packages`
permissions.
Consult the GitHub documentation on how to do this:
https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry
Set the token to the variable `CR_PAT` and then authenticate:
```shell
echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin
```
NB: You do not substitue your username for `USERNAME` in the command above.
## Testing the image
```shell
docker run -it --rm ghcr.io/paulcadman/ghc-alpine:9.2.6
```
## Pushing the image
```shell
docker push ghcr.io/paulcadman/ghc-alpine:9.2.6
```