Skip to content

visortelle/haskellfoundation.github.io

 
 

Repository files navigation

Haskell Foundation

The Haskell Foundation Website

Hackage

This repository is for the haskell.foundation website. It is a proud, Hakyll-based site, built as an in-kind contribution from Obsidian Systems, and maintained by the Haskell Foundation and its volunteers. If you would like to get started with a merge request, please consult the documentation below.

Table Of Contents

Building

To build the project:

stack build

Once the project has built (which can take a while due to the dependencies for Hakyll), to generate the site use:

stack exec -- site build

The site will be build in the _site directory, and you can open the files in your browser of choice. Due to a Hakyll issue, some sponsor logos will not show up correctly. This is expected behavior, and should be fine for the deployed site.

For further information, please refer to the CONTRIBUTING.md at the root of this project.

CI

We use GitHub Actions .github/workflows/main.yml to build the site for production.

The general steps are:

  1. Check out the hakyll branch
  2. Install Haskell
  3. Restore the cached build artefacts
  4. Build the site executable
  5. Rebuild the site contents using the site executable
  6. Check out the main branch
  7. Copy the _site directory over the main branch contents
  8. Commit and push the site contents to the main branch.

Deployment

Available Deployments

Deployment is automated for branches in the original repository.

PRs deployment

When you are submitting a PR, it's a good practice to provide a link to a running website demo.

First you should enable GitHub pages for you forked repository.

Screen Shot 2021-12-29 at 10 28 32 PM

Then you should manually trigger a build for your branch in your forker repository.

Screen Shot 2021-12-29 at 10 25 19 PM

At first time it can take a while because there is no cache for Hakyll dependencies at your GitHub actions runner yet. You can attach a link to running CI job to the PR and go drink coffee.

License

This site is open source, and covered under the Apache 2.0 license.

About

The Haskell Foundation website, hosted by GitHub Pages.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Nix 34.1%
  • HTML 30.8%
  • CSS 29.3%
  • Haskell 3.9%
  • Shell 1.1%
  • JavaScript 0.8%