# aws/libfabric architecture

> Architecture diagram of the GitHub repository aws/libfabric, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-07-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aws/libfabric
- Repository: https://github.com/aws/libfabric

## Overview

1. This repository is not the libfabric source tree. It is an AWS-owned release automation repo whose only job is to publish AWS-branded GitHub Releases for libfabric.

2. The main architectural boundary is external: active development and source live in `ofiwg/libfabric`, while this repo contains the GitHub Actions logic that turns upstream libfabric releases into tagged AWS releases.

3. The core execution layer is GitHub Actions. The `.github/workflows` directory defines the automation pipeline, and the repo has no application runtime, service code, or local build system beyond release scripting.

4. `release-from-upstream.yml` is the primary orchestration workflow. Based on its name and the README, it likely reacts to upstream release events or release tags from `ofiwg/libfabric`, then creates or updates the AWS release counterpart in this repo.

5. `publish-linked-artifacts.yml` is the publishing stage. It likely takes artifacts produced or referenced by the release workflow and attaches them to the GitHub Release so downstream users can download AWS-published assets.

6. The two shell scripts under `.github/scripts` are the reusable release helpers:
   - `derive-release-version.sh` computes the release version used in tagging or naming.
   - `render-release-body.sh` formats the release notes/body that appear on the GitHub Release page.
   These scripts form the small imperative layer beneath the workflows.

7. The data flow is release-centered: upstream libfabric release information enters the workflows, is normalized into a version and release body, and then exits as a tagged GitHub Release with linked artifacts in this AWS repo.

8. `lint-workflows.yml` is a governance/quality gate for the automation itself. It validates the workflow definitions so the release pipeline remains safe and maintainable.

9. `.github/zizmor.yml` adds security-focused linting for GitHub Actions workflows. This is an important architectural control because the repo’s “product” is automation, so workflow hygiene matters as much as code quality would in a software service.

10. `.github/dependabot.yml` provides dependency update automation for the GitHub Actions ecosystem used here. That keeps the release machinery current without changing the release content itself.

11. The repository therefore has three clear subsystems:
   - workflow orchestration,
   - release content generation,
   - workflow governance/security.
   There is no separate backend/frontend split or long-running service boundary.

12. For an architecture diagram, the most important nodes are:
   - upstream `ofiwg/libfabric`,
   - GitHub Actions workflows in this repo,
   - helper shell scripts,
   - GitHub Releases as the output destination.
   The arrows should show upstream release metadata flowing into workflows, then into version/body generation, and finally into published tagged releases and artifacts.

Main entry points: [`.github/workflows/release-from-upstream.yml`](https://github.com/aws/libfabric/blob/actions/.github/workflows/release-from-upstream.yml) (Release from upstream), [`.github/workflows/publish-linked-artifacts.yml`](https://github.com/aws/libfabric/blob/actions/.github/workflows/publish-linked-artifacts.yml) (Publish artifacts), [`.github/workflows/lint-workflows.yml`](https://github.com/aws/libfabric/blob/actions/.github/workflows/lint-workflows.yml) (Lint workflows), [`.github/zizmor.yml`](https://github.com/aws/libfabric/blob/actions/.github/zizmor.yml) (Zizmor rules)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_external["External source"]
  node_upstream_libfabric["Upstream libfabric<br/>external source"]
  node_github_releases[("GitHub Releases<br/>release target")]
end

subgraph group_workflows["Workflows"]
  node_release_from_upstream["Release from upstream<br/>workflow"]
  node_publish_linked_artifacts["Publish artifacts<br/>workflow"]
end

subgraph group_helpers["Release helpers"]
  node_derive_release_version["Derive version<br/>shell helper"]
  node_render_release_body["Render body<br/>shell helper"]
end

subgraph group_governance["Governance"]
  node_lint_workflows["Lint workflows<br/>workflow check<br/>[lint-workflows.yml]"]
  node_zizmor["Zizmor rules<br/>security lint<br/>[zizmor.yml]"]
  node_dependabot["Dependabot<br/>update automation<br/>[dependabot.yml]"]
end

node_upstream_libfabric -->|"release metadata"| node_release_from_upstream
node_release_from_upstream -->|"compute version"| node_derive_release_version
node_release_from_upstream -->|"compose notes"| node_render_release_body
node_derive_release_version -->|"tag/version"| node_github_releases
node_render_release_body -->|"release body"| node_github_releases
node_release_from_upstream -->|"handoff"| node_publish_linked_artifacts
node_publish_linked_artifacts -->|"attach assets"| node_github_releases
node_lint_workflows -.->|"validate"| node_release_from_upstream
node_lint_workflows -.->|"validate"| node_publish_linked_artifacts
node_zizmor -.->|"secure"| node_release_from_upstream
node_zizmor -.->|"secure"| node_publish_linked_artifacts
node_dependabot -.->|"update deps"| node_lint_workflows

click node_release_from_upstream "https://github.com/aws/libfabric/blob/actions/.github/workflows/release-from-upstream.yml"
click node_publish_linked_artifacts "https://github.com/aws/libfabric/blob/actions/.github/workflows/publish-linked-artifacts.yml"
click node_derive_release_version "https://github.com/aws/libfabric/blob/actions/.github/scripts/derive-release-version.sh"
click node_render_release_body "https://github.com/aws/libfabric/blob/actions/.github/scripts/render-release-body.sh"
click node_lint_workflows "https://github.com/aws/libfabric/blob/actions/.github/workflows/lint-workflows.yml"
click node_zizmor "https://github.com/aws/libfabric/blob/actions/.github/zizmor.yml"
click node_dependabot "https://github.com/aws/libfabric/blob/actions/.github/dependabot.yml"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_upstream_libfabric,node_github_releases toneBlue
class node_release_from_upstream,node_publish_linked_artifacts toneAmber
class node_derive_release_version,node_render_release_body toneMint
class node_lint_workflows,node_zizmor,node_dependabot toneRose
```

## Components

### External source

Upstream libfabric release stream consumed by this repo.

- **Upstream libfabric**: external source · Authoritative release and source project in ofiwg/libfabric.
- **GitHub Releases**: release target · Destination for AWS-tagged release pages and published assets.

### Workflows

GitHub Actions orchestration for release automation.

- [Release from upstream](https://github.com/aws/libfabric/blob/actions/.github/workflows/release-from-upstream.yml): workflow · Primary workflow that turns upstream libfabric releases into AWS-branded releases. · `.github/workflows/release-from-upstream.yml`
- [Publish artifacts](https://github.com/aws/libfabric/blob/actions/.github/workflows/publish-linked-artifacts.yml): workflow · Workflow that attaches linked build or release artifacts to the GitHub Release. · `.github/workflows/publish-linked-artifacts.yml`

### Release helpers

Reusable shell helpers for versioning and release notes.

- [Derive version](https://github.com/aws/libfabric/blob/actions/.github/scripts/derive-release-version.sh): shell helper · Computes the release version used for tags and naming. · `.github/scripts/derive-release-version.sh`
- [Render body](https://github.com/aws/libfabric/blob/actions/.github/scripts/render-release-body.sh): shell helper · Formats the release notes and body content for the release page. · `.github/scripts/render-release-body.sh`

### Governance

Automation hygiene and dependency maintenance for workflows.

- [Lint workflows](https://github.com/aws/libfabric/blob/actions/.github/workflows/lint-workflows.yml): workflow check · Validates workflow definitions and release automation structure. · `.github/workflows/lint-workflows.yml`
- [Zizmor rules](https://github.com/aws/libfabric/blob/actions/.github/zizmor.yml): security lint · Security-focused GitHub Actions lint configuration. · `.github/zizmor.yml`
- [Dependabot](https://github.com/aws/libfabric/blob/actions/.github/dependabot.yml): update automation · Keeps GitHub Actions and related dependencies current. · `.github/dependabot.yml`

## Connections

- Upstream libfabric → Release from upstream: release metadata · Upstream release events or tags trigger the AWS release workflow.
- Release from upstream → Derive version: compute version · The workflow normalizes upstream information into a release version.
- Release from upstream → Render body: compose notes · The workflow generates the GitHub Release body from upstream release context.
- Derive version → GitHub Releases: tag/version · Derived version becomes the AWS release tag or name.
- Render body → GitHub Releases: release body · Rendered notes are published on the release page.
- Release from upstream → Publish artifacts: handoff · Primary release orchestration hands off to artifact publication.
- Publish artifacts → GitHub Releases: attach assets · Artifacts are linked to the published GitHub Release.
- Lint workflows → Release from upstream: validate · Workflow linting guards the main release automation.
- Lint workflows → Publish artifacts: validate · Workflow linting guards the artifact publishing stage.
- Zizmor rules → Release from upstream: secure · Security policy reviews the primary workflow definition.
- Zizmor rules → Publish artifacts: secure · Security policy reviews the artifact publishing workflow.
- Dependabot → Lint workflows: update deps · Dependency automation keeps workflow tooling current.
