helix - Unnamed repository; edit this file 'description' to name the repository.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

name: Build
on:
  pull_request:
  push:
    branches:
      - master
  merge_group:
  schedule:
    - cron: "00 01 * * *"

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

permissions:
  contents: read

env:
  MSRV: "1.90"
  # This key can be changed to bust the cache of tree-sitter grammars.
  GRAMMAR_CACHE_VERSION: ""

jobs:
  check:
    name: Check (msrv)
    runs-on: ubuntu-latest
    if: github.repository == 'helix-editor/helix' || github.event_name != 'schedule'
    steps:
      - name: Checkout sources
        uses: actions/checkout@v7

      - uses: ./.github/actions/rust-setup
        with:
          toolchain: ${{ env.MSRV }}
          cache-key: build

      - name: Run cargo check
        run: cargo check

  test:
    name: Test Suite
    runs-on: ${{ matrix.os }}
    if: github.repository == 'helix-editor/helix' || github.event_name != 'schedule'
    timeout-minutes: 30
    env:
      RUST_BACKTRACE: 1
      HELIX_LOG_LEVEL: info
    steps:
      - name: Checkout sources
        uses: actions/checkout@v7

      - uses: ./.github/actions/rust-setup
        with:
          toolchain: ${{ env.MSRV }}
          cache-key: build
          cache-grammars: 'true'
          grammar-cache-version: ${{ env.GRAMMAR_CACHE_VERSION }}

      - name: Run cargo test
        run: cargo test --workspace

      - name: Run cargo integration-test
        run: cargo integration-test

    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest, ubuntu-24.04-arm, windows-11-arm]

  lints:
    name: Lints
    runs-on: ubuntu-latest
    if: github.repository == 'helix-editor/helix' || github.event_name != 'schedule'
    steps:
      - name: Checkout sources
        uses: actions/checkout@v7

      - uses: ./.github/actions/rust-setup
        with:
          toolchain: ${{ env.MSRV }}
          components: rustfmt, clippy
          cache-key: build

      - name: Run cargo fmt
        run: cargo fmt --all --check

      - name: Run cargo clippy
        run: cargo clippy --workspace --all-targets -- -D warnings

      - name: Run cargo doc
        run: cargo doc --no-deps --workspace --document-private-items
        env:
          RUSTDOCFLAGS: -D warnings

  docs:
    name: Grammar Lint
    runs-on: ubuntu-latest
    if: github.repository == 'helix-editor/helix' || github.event_name != 'schedule'
    steps:
      - name: Checkout sources
        uses: actions/checkout@v7

      - uses: ./.github/actions/rust-setup
        with:
          toolchain: ${{ env.MSRV }}
          cache-key: build
          cache-grammars: 'true'
          grammar-cache-version: ${{ env.GRAMMAR_CACHE_VERSION }}

      - name: Validate queries
        if: always()
        run: cargo xtask query-check

      - name: Validate indents
        if: always()
        run: cargo xtask indent-check

      - name: Validate highlights
        if: always()
        run: cargo xtask highlight-check

      - name: Validate themes
        if: always()
        run: cargo xtask theme-check

      - name: Generate docs
        if: always()
        run: cargo xtask docgen

      - name: Check uncommitted documentation changes
        if: always()
        run: |
          git diff
          git diff-files --quiet \
            || (echo "Run 'cargo xtask docgen', commit the changes and push again" \
            && exit 1)