Skip to content

Commit d68be54

Browse files
authored
Merge pull request #145 from AndreiDurlea/andreidurlea-issue118
Fix trunk checker fail
2 parents ce35848 + 5f73d66 commit d68be54

14 files changed

Lines changed: 6172 additions & 5849 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ on:
77
branches:
88
- main
99

10+
permissions:
11+
contents: read
12+
1013
jobs:
1114
build:
1215
name: Build static content

.github/workflows/trunk-check.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,3 @@ jobs:
2222

2323
- name: Trunk Check
2424
uses: trunk-io/trunk-action@v1
25-
with:
26-
check-mode: all
27-
post-annotations: true

.markdownlint.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
2+
# Disable inline HTML linter to allow for MDX components and Docusaurus HTML/JSX tags.
3+
MD033: false
4+
5+
# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
6+
# Suppress warning about sibling headings while ensuring they are unique globally unless they belong to different parents.
7+
MD024:
8+
siblings_only: true
9+
10+
# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md
11+
# Disable to allow both frontmatter titles and explicit # H1 tags in the same file if needed for specific page layouts.
12+
MD025: false

.trunk/trunk.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,17 @@ runtimes:
1717
- python@3.10.8
1818
# This is the section where you manage your linters. (https://docs.trunk.io/check/configuration)
1919
lint:
20+
ignore:
21+
- linters: [osv-scanner]
22+
paths: [yarn.lock]
23+
- linters: [ALL]
24+
paths:
25+
- docs/**/*.md
26+
- docs/images/**
27+
- images/**
28+
- static/docs/images/**
29+
- static/images/**
30+
- static/img/**
2031
enabled:
2132
- actionlint@1.7.9
2233
- bandit@1.9.2

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ The CI preview deployment logs should be public. Please ping a codeowner otherwi
9090

9191
- Logs inspect example:
9292

93-
![](./images/tutorial/add-a-blog/ci-preview-deployment-failure-message.gif)
93+
![CI preview deployment failure message](./images/tutorial/add-a-blog/ci-preview-deployment-failure-message.gif)
9494

9595
- Fix the error, commit and push the changes. Wait for new deployment.
9696

blog/2025-09-15-beman-infra-containers/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This is where [bemanproject/infra-containers](https://github.com/bemanproject/in
1919
- How does it work?
2020
- How is it used?
2121

22-
# What is it?
22+
## What is it?
2323

2424
In short, `bemanproject/infra-containers` is a set of [Docker](https://www.docker.com/) container images that can be reused in CI pipelines across the Beman library projects. These containers are automatically built and published to the GitHub package registry under the [bemanproject organization](https://github.com/orgs/bemanproject/packages). Why do this? There are several advantages:
2525

@@ -31,13 +31,13 @@ Additionally, this setup allows us to build containers that contain pre-release
3131

3232
The `infra-containers` repository also builds `devcontainer` images which are used as online development environments via [GitHub Codespaces](https://github.com/features/codespaces) for the Beman library projects.
3333

34-
# How does it work?
34+
## How does it work?
3535

3636
When a change is made to the `Dockerfile` definitions in the [infra-containers](https://github.com/bemanproject/infra-containers) repository, a series of GitHub Actions are started that build and publish the containers to the package registry, both for production and staging use. These actions additionally run weekly or they can be invoked manually if needed.
3737

3838
If you're not familiar with Docker or containers in general, this may seem like magic. To simplify things, you can think of these images as "virtual" operating systems that have been pre-configured with specific versions of certain tools. For [fast turnaround, binary caching, and building compiler forks](https://www.gentoo.org/) the CI images are built on top of [Gentoo Linux](https://www.gentoo.org/). The devcontainer images are built on top of Ubuntu so that Microsoft's devcontainer images can be used as a base.
3939

40-
# How is it used?
40+
## How is it used?
4141

4242
The simplest way to understand how the infra-containers are used is to look at an example. We will use [bemanproject/task](https://github.com/bemanproject/task) for this purpose as it runs tests with a large and diverse set of configurations. If we look at its [CI GitHub actions workflow](https://github.com/bemanproject/task/blob/66da7a2c82f681c0ae1440bc4940626b2791eb9c/.github/workflows/ci_tests.yml#L35), we can see a JSON object used to configure CI. Excerpted below is the Clang portion:
4343

docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ const config: Config = {
116116
label: "Docs",
117117
},
118118
{ to: "/libraries", label: "Libraries", position: "left" },
119-
{ to: "/talks", label: "Talks", position: 'left'},
119+
{ to: "/talks", label: "Talks", position: "left" },
120120
{ to: "/blog", label: "Blog", position: "left" },
121121
{
122122
"aria-label": "Discourse Forum",

0 commit comments

Comments
 (0)