Merge request #727 GitHub CI: autogenerate the README TOC
When README changes in master, this workflow runs and autochecks, autogenerates the idempotent TOC and autocommits it, so project TOC persistently stays current.
This commit is contained in:
Anton Latukha
GitHub
commit
7d7a39bdf6
|
|
@ -0,0 +1,33 @@
|
|||
name: "On README change"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
paths:
|
||||
- "README.md"
|
||||
|
||||
jobs:
|
||||
|
||||
build10:
|
||||
name: "Check TOC, autogenerate and commit it into the PR"
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
steps:
|
||||
- name: Install doctoc
|
||||
run: |
|
||||
sudo npm install -g doctoc
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
# 2020-09-29: Official doc:
|
||||
# "In non-push events, such as pull_request, make sure to specify the ref to checkout:'
|
||||
ref: ${{ github.head_ref }}
|
||||
- name: Generate the idenpotent TOC
|
||||
run: |
|
||||
doctoc --github --notitle README.md
|
||||
- name: Commit and push changes
|
||||
uses: stefanzweifel/git-auto-commit-action@v4
|
||||
with:
|
||||
commit_author: "Anton Latukha <anton@latukha.com>"
|
||||
commit_message: "[auto] upd README TOC"
|
||||
file_pattern: "README.md"
|
||||
61
README.md
61
README.md
|
|
@ -1,5 +1,16 @@
|
|||
# hnix
|
||||
|
||||
Haskell parser, evaluator and type checker for the Nix language.
|
||||
|
||||
## Contents
|
||||
|
||||
<!-- TOC generates automatically, do not bother editing any further TOC text -->
|
||||
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
||||
|
||||
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||||
|
||||
---
|
||||
|
||||
| [](https://gitter.im/haskell-nix/Lobby) | CI |
|
||||
| :--- | :--- |
|
||||
| [](https://hackage.haskell.org/package/hnix) | [](https://github.com/haskell-nix/hnix/actions?query=workflow%3A"Hackage%2C+Cabal%2C+Linux"+branch%3Amaster) |
|
||||
|
|
@ -8,21 +19,7 @@
|
|||
| [](https://packdeps.haskellers.com/feed?needle=hnix) | [](https://github.com/haskell-nix/hnix/actions?query=workflow%3A%22Nixpkgs%2C+macOS%22+branch%3Amaster) |
|
||||
| [](https://repology.org/project/haskell:hnix/versions) | |
|
||||
|
||||
Haskell parser, evaluator and type checker for the Nix language.
|
||||
|
||||
## Contents
|
||||
|
||||
<!-- TOC -->
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Using the REPL](#using-the-repl)
|
||||
- [Building with full debug info](#building-with-full-debug-info)
|
||||
- [Building with benchmarks enabled](#building-with-benchmarks-enabled)
|
||||
- [Building with profiling enabled](#building-with-profiling-enabled)
|
||||
- [Using the Cachix binary cache](#using-the-cachix-binary-cache)
|
||||
- [Contributing](#contributing)
|
||||
- [Evaluating Nixpkgs with HNix](#evaluating-nixpkgs-with-hnix)
|
||||
<!-- /TOC -->
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
Until `hnix-store` is ready, `nix-store` is still used for interacting with the store paths, so Nix is still required installed and available through `$PATH`.
|
||||
|
|
@ -72,20 +69,19 @@ hnix --eval -E '(import <nixpkgs> {}).pkgs.hello' --repl
|
|||
|
||||
Use the `:help` command for a list of all available REPL commands.
|
||||
|
||||
## Building with full debug info
|
||||
|
||||
To build `hnix` for debugging, and with full tracing output and stack traces, use:
|
||||
## Cachix prebuild binary caches
|
||||
|
||||
```
|
||||
nix-shell
|
||||
cabal v2-configure --enable-tests --enable-profiling --flags=profiling --flags=tracing
|
||||
cabal v2-build
|
||||
cabal v2-run hnix -- -v5 --trace <args> +RTS -xc
|
||||
```
|
||||
To autoload prebuild project dependencies - please, enable the official HNix Cachix binary cache:
|
||||
|
||||
Note that this will run quite slowly, but will give the most information as to what might potentially be going wrong during parsing or evaluation.
|
||||
1. Go through https://cachix.org/ and set it up.
|
||||
|
||||
## Building with benchmarks enabled
|
||||
2. Run: `cachix use hnix`
|
||||
|
||||
|
||||
## Building
|
||||
|
||||
### With benchmarks
|
||||
|
||||
To build `hnix` with benchmarks enabled:
|
||||
|
||||
|
|
@ -96,7 +92,7 @@ cabal v2-build
|
|||
cabal v2-bench
|
||||
```
|
||||
|
||||
## Building with profiling enabled
|
||||
### With profiling
|
||||
|
||||
To build `hnix` with profiling enabled:
|
||||
|
||||
|
|
@ -107,15 +103,20 @@ cabal v2-build
|
|||
cabal v2-run hnix -- <args> +RTS -p
|
||||
```
|
||||
|
||||
## Using the Cachix binary cache
|
||||
### With full debug info
|
||||
|
||||
If you're on macOS, you can use the binary cache at Cachix to avoid building the specific dependencies used by hnix. Just use these commands:
|
||||
To build `hnix` for debugging, with full tracing output and stack traces:
|
||||
|
||||
```
|
||||
nix-env -iA cachix -f https://github.com/NixOS/nixpkgs/tarball/db557aab7b690f5e0e3348459f2e4dc8fd0d9298
|
||||
cachix use hnix
|
||||
nix-shell
|
||||
cabal v2-configure --enable-tests --enable-profiling --flags=profiling --flags=tracing
|
||||
cabal v2-build
|
||||
cabal v2-run hnix -- -v5 --trace <args> +RTS -xc
|
||||
```
|
||||
|
||||
Note that this will run quite slowly, but will give the most information as to what might potentially be going wrong during parsing or evaluation.
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
1. If something in the [quests](https://github.com/haskell-nix/hnix/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) looks interesting, look through the thread and leave a comment taking it, to let others know you're working on it.
|
||||
|
|
|
|||
Loading…
Reference in New Issue