Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/deploy.yml

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should keep your changes in .github / .trunk directories.

Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ on:
branches:
- main

permissions:
contents: read

jobs:
build:
name: Build static content
Expand Down
3 changes: 0 additions & 3 deletions .github/workflows/trunk-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,3 @@ jobs:

- name: Trunk Check
uses: trunk-io/trunk-action@v1
with:
check-mode: all
post-annotations: true
12 changes: 12 additions & 0 deletions .markdownlint.yaml
Comment thread
neatudarius marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
# Disable inline HTML linter to allow for MDX components and Docusaurus HTML/JSX tags.
MD033: false

# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
# Suppress warning about sibling headings while ensuring they are unique globally unless they belong to different parents.
MD024:
siblings_only: true

# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md
# Disable to allow both frontmatter titles and explicit # H1 tags in the same file if needed for specific page layouts.
MD025: false
11 changes: 11 additions & 0 deletions .trunk/trunk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ runtimes:
- python@3.10.8
# This is the section where you manage your linters. (https://docs.trunk.io/check/configuration)
lint:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

ignore:
- linters: [osv-scanner]
paths: [yarn.lock]
- linters: [ALL]
paths:
- docs/**/*.md
- docs/images/**
- images/**
- static/docs/images/**
- static/images/**
- static/img/**
enabled:
- actionlint@1.7.9
- bandit@1.9.2
Expand Down
2 changes: 1 addition & 1 deletion README.md

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We keep changes here if it's working - please check the render version of each changed MD!

Image

Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The CI preview deployment logs should be public. Please ping a codeowner otherwi

- Logs inspect example:

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

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

Expand Down
6 changes: 3 additions & 3 deletions blog/2025-09-15-beman-infra-containers/index.md

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes in this files are also OK to keep.

Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This is where [bemanproject/infra-containers](https://github.com/bemanproject/in
- How does it work?
- How is it used?

# What is it?
## What is it?

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:

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

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.

# How does it work?
## How does it work?

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.

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.

# How is it used?
## How is it used?

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:

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We keep changes here.

Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ const config: Config = {
label: "Docs",
},
{ to: "/libraries", label: "Libraries", position: "left" },
{ to: "/talks", label: "Talks", position: 'left'},
{ to: "/talks", label: "Talks", position: "left" },
{ to: "/blog", label: "Blog", position: "left" },
{
"aria-label": "Discourse Forum",
Expand Down
Loading
Loading