Skip to content
Snippets Groups Projects
Verified Commit f34e8803 authored by Olivier Benz's avatar Olivier Benz
Browse files

Lint and update Markdown files

parent 71f59845
Branches
No related tags found
No related merge requests found
......@@ -2,17 +2,17 @@
These Dev Containers provide the following tools:
- The
* The
[Haskell Toolchain](https://www.haskell.org/ghcup/install/#supported-tools)
([GHC](https://www.haskell.org/ghc),
[Cabal (the tool)](https://cabal.readthedocs.io),
[Stack](https://docs.haskellstack.org), and
[HLS](https://haskell-language-server.readthedocs.io))
- [Git](https://git-scm.com)
- [HLint](https://hackage.haskell.org/package/hlint)
- [yamllint](https://yamllint.readthedocs.io)
- [ShellCheck](https://www.shellcheck.net)
- [hadolint](https://github.com/hadolint/hadolint)
* [Git](https://git-scm.com)
* [HLint](https://hackage.haskell.org/package/hlint)
* [yamllint](https://yamllint.readthedocs.io)
* [ShellCheck](https://www.shellcheck.net)
* [hadolint](https://github.com/hadolint/hadolint)
The tools in the Haskell Toolchain are installed at `/usr/local/bin`
[^1]<sup>,</sup>[^2].
......@@ -32,7 +32,7 @@ extensions pre‑installed:
* [GitHub Pull Requests and Issues](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github)
* [GitLab Workflow](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow)
* [GitLens — Git supercharged](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
* Pinned to v11.7.0 due to unsolicited AI content in recent versions.
* Pinned to v11.7.0 due to unsolicited AI content in recent versions.
* [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph)
* [hadolint](https://marketplace.visualstudio.com/items?itemName=exiasr.hadolint)
* [Haskell](https://marketplace.visualstudio.com/items?itemName=haskell.haskell)
......
......@@ -20,6 +20,7 @@
!/.gitignore
!/.gitlab-ci.yml
!/.hadolint.yaml
!/.markdownlint.yml
!/CODE_OF_CONDUCT.md
!/latest.Dockerfile
!/LICENSE
......
MD033: false
MD041: false
......@@ -45,16 +45,16 @@ or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for
moderation decisions when appropriate.
not aligned to this Code of Conduct, and will communicate reasons formoderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail
address, posting via an official social media account, or acting as an
appointed representative at an online or offline event.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
......@@ -116,13 +116,17 @@ the community.
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
[![minimal-readme compliant](https://img.shields.io/badge/readme%20style-minimal-brightgreen.svg)](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/minimal-readme.md) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) <a href="https://liberapay.com/benz0li/donate"><img src="https://liberapay.com/assets/widgets/donate.svg" alt="Donate using Liberapay" height="20"></a> <a href='https://codespaces.new/benz0li/ghc-musl?hide_repo_select=true&ref=main'><img src='https://github.com/codespaces/badge.svg' alt='Open in GitHub Codespaces' height="20" style='max-width: 100%;'></a>
# GHC musl
[![minimal-readme compliant](https://img.shields.io/badge/readme%20style-minimal-brightgreen.svg)](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/minimal-readme.md) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) <a href="https://liberapay.com/benz0li/donate"><img src="https://liberapay.com/assets/widgets/donate.svg" alt="Donate using Liberapay" height="20"></a> <a href='https://codespaces.new/benz0li/ghc-musl?hide_repo_select=true&ref=main'><img src='https://github.com/codespaces/badge.svg' alt='Open in GitHub Codespaces' height="20" style='max-width: 100%;'></a>
The multi‑arch (`linux/amd64`, `linux/arm64/v8`) docker image used to build the
*statically linked* Linux amd64 and arm64 binary releases of
......@@ -11,21 +11,21 @@ The multi‑arch (`linux/amd64`, `linux/arm64/v8`) docker image used to build th
Credits to
* [@odidev](https://github.com/odidev) for [ghc-bootstrap-aarch64](https://gitlab.alpinelinux.org/odidev/ghc-bootstrap-aarch64)
* [@odidev](https://github.com/odidev) for [ghc-bootstrap-aarch64](https://gitlab.alpinelinux.org/odidev/ghc-bootstrap-aarch64)
and
* [@neosimsim](https://github.com/neosimsim) for
[docker-builder-images](https://gitlab.com/neosimsim/docker-builder-images)
* [@neosimsim](https://github.com/neosimsim) for
[docker-builder-images](https://gitlab.com/neosimsim/docker-builder-images)
who laid the groundwork for [this](https://gitlab.com/benz0li/ghc-musl).
## Table of Contents
* [Prerequisites](#prerequisites)
* [Install](#install)
* [Usage](#usage)
* [Similar projects](#similar-projects)
* [Contributing](#contributing)
* [License](#license)
* [Prerequisites](#prerequisites)
* [Install](#install)
* [Usage](#usage)
* [Similar projects](#similar-projects)
* [Contributing](#contributing)
* [License](#license)
## Prerequisites
......@@ -35,8 +35,8 @@ This project requires an installation of docker.
To install docker, follow the instructions for your platform:
* [Install Docker Engine | Docker Documentation > Supported platforms](https://docs.docker.com/engine/install/#supported-platforms)
* [Post-installation steps for Linux](https://docs.docker.com/engine/install/linux-postinstall/)
* [Install Docker Engine | Docker Documentation > Supported platforms](https://docs.docker.com/engine/install/#supported-platforms)
* [Post-installation steps for Linux](https://docs.docker.com/engine/install/linux-postinstall/)
## Usage
......
......@@ -6,7 +6,7 @@ updates.
## Reporting a Vulnerability
To report a vulnerability in the latest docker image, email the maintainer
olivier.benz@b-data.ch.
<olivier.benz@b-data.ch>.
## Vulnerabilities in Prior Versions
......
......@@ -38,4 +38,4 @@ Topmost entry = Tag `latest`
## Bug fixes
* Images based on Alpine 3.{17,18}: Package pkgconf downgraded to v1.8.1
* Due to https://github.com/haskell/cabal/issues/8923
* Due to <https://github.com/haskell/cabal/issues/8923>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment