Merge branch 'main' into freeze-version

d070c806 · Olivier Benz · 87fdd739 · 68f74dd0 · d070c806 · d070c806
Verified Commit d070c806 authored 2 years ago by Olivier Benz
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
+github: benz0li
+liberapay: benz0li
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -6,7 +6,7 @@
    fi
  - |
    export CI_APP_REPO=${CI_APP_REPO:-$CI_REGISTRY_IMAGE}
-    if [[ $CI_COMMIT_BRANCH == "master" ]]; then
+    if [[ $CI_COMMIT_BRANCH == "main" ]]; then
      export CI_APP_TAG=${CI_APP_TAG:-latest}
    elif [[ $CI_COMMIT_BRANCH == "freeze-version" ]]; then
      export CI_APP_TAG=${CI_APP_TAG:-$GHC_VERSION_BUILD}
@@ -33,7 +33,7 @@
  variables:
    DOCKER_DRIVER: overlay2
    DOCKER_TLS_CERTDIR: "/certs"
-    GHC_VERSION_BUILD: "9.4.1"
+    GHC_VERSION_BUILD: "9.4.2"
    CABAL_VERSION_BUILD: "3.8.1.0"
  before_script:
    - *before-script-build
@@ -55,7 +55,7 @@ build:latest-linux-amd64:
      docker push $CI_APP_REPO:$CI_APP_TAG-linux-amd64
      docker push $CI_APP_REPO:$VERSION_MAJ_MIN_PAT-linux-amd64
  rules:
-    - if: $CI_COMMIT_BRANCH == "master" && $CI_BUILD_PLATFORMS =~ /(linux\/amd64)/
+    - if: $CI_COMMIT_BRANCH == "main" && $CI_BUILD_PLATFORMS =~ /(linux\/amd64)/
      changes:
        - latest.Dockerfile

@@ -76,7 +76,7 @@ build:latest-linux-arm64v8:
      docker push $CI_APP_REPO:$CI_APP_TAG-linux-arm64v8
      docker push $CI_APP_REPO:$VERSION_MAJ_MIN_PAT-linux-arm64v8
  rules:
-    - if: $CI_COMMIT_BRANCH == "master" && $CI_BUILD_PLATFORMS =~ /(linux\/arm64\/v8)/
+    - if: $CI_COMMIT_BRANCH == "main" && $CI_BUILD_PLATFORMS =~ /(linux\/arm64\/v8)/
      changes:
        - latest.Dockerfile

@@ -149,7 +149,7 @@ build-manifest:latest-linux-multiarch:
      fi
      docker manifest push $CI_APP_REPO:$VERSION_MAJ
  rules:
-    - if: $CI_COMMIT_BRANCH == "master"
+    - if: $CI_COMMIT_BRANCH == "main"
      changes:
        - latest.Dockerfile


--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+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.
+
+## 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<olivier.benz@b-data.ch>. All complaints will be reviewed and investigated
+promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+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.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+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.
--- a/LICENSE
+++ b/LICENSE
 MIT License

-Copyright (c) 2021 b-data GmbH
+Copyright (c) 2021 Olivier Benz

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

--- a/README.md
+++ b/README.md
-<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://benz0li.b-data.io/donate?project=1"><img src="https://benz0li.b-data.io/donate/static/donate-with-fosspay.png" alt="Donate with fosspay"></a>
+[![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>

 # GHC for pandoc

 The multi-arch (`linux/amd64`, `linux/arm64/v8`) docker image used to build the
-amd64 and arm64 binary
+Linux amd64 and arm64 binary
 [releases of pandoc](https://github.com/jgm/pandoc/releases).

 Credits to
@@ -13,4 +13,78 @@ Credits to
 *  [@neosimsim](https://github.com/neosimsim) for
   [docker-builder-images](https://gitlab.com/neosimsim/docker-builder-images)

-who laid the groundwork for this.
+who laid the groundwork for [this](https://gitlab.b-data.ch/ghc/ghc4pandoc).
+
+## Table of Contents
+
+*  [Prerequisites](#prerequisites)
+*  [Install](#install)
+*  [Usage](#usage)
+*  [Similar project](#similar-project)
+*  [Contributing](#contributing)
+*  [License](#license)
+
+## Prerequisites
+
+This projects requires an installation of docker.
+
+## Install
+
+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/)
+
+## Usage
+
+### Build image
+
+latest:
+
+```bash
+docker build \
+  --build-arg GHC_VERSION_BUILD=9.4.2 \
+  --build-arg CABAL_VERSION_BUILD=3.8.1.0 \
+  -t ghc4pandoc \
+  -f latest.Dockerfile .
+```
+
+version:
+
+```bash
+docker build \
+  -t ghc4pandoc:<major>.<minor>.<patch> \
+  -f <major>.<minor>.<patch>.Dockerfile .
+```
+
+For `<major>.<minor>.<patch>` GHC versions `8.8.4`, `8.10.1` and ≥ `8.10.4`.
+
+### Run container
+
+self built:
+
+```bash
+docker run --rm -ti ghc4pandoc[:<major>.<minor>.<patch>]
+```
+
+from [the project's GitLab Container Registry](https://gitlab.b-data.ch/ghc/ghc4pandoc/container_registry):
+
+```bash
+docker run --rm -ti registry.gitlab.b-data.ch/ghc/ghc4pandoc[:<major>[.<minor>[.<patch>]]]
+```
+
+## Similar project
+
+* [utdemir/ghc-musl](https://github.com/utdemir/ghc-musl)
+
+## Contributing
+
+PRs accepted.
+
+This project follows the
+[Contributor Covenant](https://www.contributor-covenant.org)
+[Code of Conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+[MIT](LICENSE) © 2021 Olivier Benz
--- a/bootstrap/arm64.Dockerfile
+++ b/bootstrap/arm64.Dockerfile
@@ -26,7 +26,7 @@ RUN apk add --update --no-cache \
    zlib-dev

 RUN cd /tmp/ \
-  && wget https://gitlab.b-data.ch/ghc/ghc-bootstrap-aarch64/-/raw/master/ghc-8.8.3-r0.apk \
+  && wget https://gitlab.b-data.ch/ghc/ghc-bootstrap-aarch64/-/raw/main/ghc-8.8.3-r0.apk \
  && apk add --allow-untrusted ghc-8.8.3-r0.apk \
  && curl -sSLO https://downloads.haskell.org/~cabal/cabal-install-$CABAL_VERSION/cabal-install-$CABAL_VERSION.tar.gz \
  && tar zxf cabal-install-$CABAL_VERSION.tar.gz \
@@ -74,7 +74,7 @@ RUN apk add --update --no-cache \
    zlib-dev \
    #zlib-static \
  && cd /tmp/ \
-  && wget https://gitlab.b-data.ch/ghc/ghc-bootstrap-aarch64/-/raw/master/ghc-8.8.3-r0.apk \
+  && wget https://gitlab.b-data.ch/ghc/ghc-bootstrap-aarch64/-/raw/main/ghc-8.8.3-r0.apk \
  && apk add --allow-untrusted ghc-8.8.3-r0.apk \
  && cd / \
  && rm -rf /tmp/*

--- a/latest.Dockerfile
+++ b/latest.Dockerfile
@@ -54,9 +54,10 @@ RUN cd /tmp \

 FROM alpine:3.16 as builder

-LABEL org.label-schema.license="MIT" \
-      org.label-schema.vcs-url="https://gitlab.b-data.ch/ghc/ghc4pandoc" \
-      maintainer="Olivier Benz <olivier.benz@b-data.ch>"
+LABEL org.opencontainers.image.licenses="MIT" \
+      org.opencontainers.image.source="https://gitlab.b-data.ch/ghc/ghc4pandoc" \
+      org.opencontainers.image.vendor="Olivier Benz" \
+      org.opencontainers.image.authors="Olivier Benz <olivier.benz@b-data.ch>"

 ARG GHC_VERSION_BUILD
 ARG CABAL_VERSION_BUILD