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
4 changes: 4 additions & 0 deletions .github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ on:
push:
branches:
- '**'
paths-ignore: &docs
- website/**
- '**.md'
pull_request:
branches:
- dev
paths-ignore: *docs

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down
4 changes: 4 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ External contributions are disabled. If you are not working for a maintainer, re
- `cargo clippy --all-targets` lints; `Cargo.toml` denies a strict lint set, and exceptions are `#[expect(lint, reason = "...")]`, never `#[allow]`.
- `cargo run --release --example benchmark -- label=image ...` compares server images (startup, memory, CPU, transfer speed, lookup latency); it needs Docker with cgroup v2.

## Docs

The docs site in `website/` is Astro Starlight on Cloudflare Workers. Cloudflare's Git integration (Workers Builds) runs `pnpm check && pnpm build` and deploys `dev`; every other branch gets a preview URL. Pages are Markdown in `website/src/content/docs/`; the sidebar and `llms.txt` both read `website/src/sidebar.ts`, so a new page goes there too. A change to configuration, drivers or runner setup updates the matching page in the same PR. Check with `pnpm check && pnpm build` in `website/`, and look at layout changes with `pnpm preview`.

## Agent skills

### Issue tracker
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,10 @@ env:
## Documentation

πŸ‘‰ <https://gha-cache-server.falcondev.io/getting-started> πŸ‘ˆ

- [Ephemeral runners with a local cache](https://gha-cache-server.falcondev.io/guides/ephemeral-runners-local-cache)
- [Actions Runner Controller (ARC)](https://gha-cache-server.falcondev.io/guides/actions-runner-controller)
- [GitHub cloud cache vs hostPath vs a local cache server](https://gha-cache-server.falcondev.io/guides/github-actions-cache-options)
- For agents: [`llms.txt`](https://gha-cache-server.falcondev.io/llms.txt). Every page is also Markdown at `<url>.md`.

The docs live in [`website/`](website).
4 changes: 4 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules/
dist/
.astro/
.wrangler/
1 change: 1 addition & 0 deletions website/.node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
24
46 changes: 46 additions & 0 deletions website/astro.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import { sections } from './src/sidebar'

const site = 'https://gha-cache-server.falcondev.io'
const repo = 'https://github.com/falcondev-oss/github-actions-cache-server'

export default defineConfig({
site,
// pages live at `/getting-started`, the URLs the old docs used; see `html_handling` in wrangler.jsonc
trailingSlash: 'never',
integrations: [
starlight({
title: 'GitHub Actions Cache Server',
description:
'Self-hosted GitHub Actions cache server written in Rust. Drop-in replacement for the GitHub cache backend: actions/cache, setup-* caches and BuildKit type=gha work unchanged on self-hosted and ephemeral runners.',
logo: { src: './src/assets/logo.svg' },
favicon: '/logo.svg',
social: [{ icon: 'github', label: 'GitHub', href: repo }],
editLink: { baseUrl: `${repo}/edit/dev/website/` },
lastUpdated: true,
customCss: [
'@fontsource-variable/geist',
'@fontsource-variable/geist-mono',
'./src/styles/theme.css',
],
expressiveCode: {
themes: ['github-dark-default', 'github-light-default'],
styleOverrides: {
borderRadius: '0.375rem',
codeFontFamily: 'var(--sl-font-mono)',
frames: { shadowColor: 'transparent' },
},
},
components: {
Head: './src/components/Head.astro',
PageTitle: './src/components/PageTitle.astro',
},
head: [
{ tag: 'meta', attrs: { property: 'og:image', content: `${site}/og.png` } },
{ tag: 'meta', attrs: { name: 'twitter:card', content: 'summary_large_image' } },
],
sidebar: sections.map(({ label, items }) => ({ label, items: [...items] })),
}),
],
})
29 changes: 29 additions & 0 deletions website/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "gha-cache-server-docs",
"type": "module",
"private": true,
"packageManager": "pnpm@12.15.0",
"engines": {
"node": ">=24"
},
"scripts": {
"dev": "astro dev",
"build": "astro build",
"preview": "pnpm build && wrangler dev",
"check": "astro check && tsc -p worker",
"deploy": "pnpm build && wrangler deploy"
},
"dependencies": {
"@astrojs/starlight": "^0.42.8",
"@fontsource-variable/geist": "^5.3.0",
"@fontsource-variable/geist-mono": "^5.3.0",
"astro": "^7.4.5",
"sharp": "^0.35.5"
},
"devDependencies": {
"@astrojs/check": "^0.9.12",
"@cloudflare/workers-types": "^5.20261104.1",
"typescript": "^6.0.3",
"wrangler": "^4.157.0"
}
}
Loading
Loading