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
33 changes: 8 additions & 25 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# InQL CI — Incan library package
#
# The compiler is built from the Incan repository on each run so this package tracks the default branch of the toolchain
# (no pre-published `incan` binary required).
# FIXME: once incan has the ability, switch to a published `incan` binary.
# Uses the reusable Incan composite action from the incan repository.
# This eliminates copy-paste drift and provides a supported integration path.
# The composite action caches built binaries for faster subsequent runs.

name: CI

Expand All @@ -21,9 +21,6 @@ env:
CARGO_TERM_COLOR: always
RUST_BACKTRACE: 1
INCAN_NO_BANNER: 1
# Pin the compiler checkout; bump when you intentionally require a newer Incan.
INCAN_REPO: dannys-code-corner/incan
INCAN_REF: main

jobs:
inql:
Expand All @@ -38,26 +35,12 @@ jobs:
- name: Check out InQL
uses: actions/checkout@v4

- name: Check out Incan (toolchain)
uses: actions/checkout@v4
with:
repository: ${{ env.INCAN_REPO }}
ref: ${{ env.INCAN_REF }}
path: incan

- uses: dtolnay/rust-toolchain@stable

- name: Cache Incan build
uses: Swatinem/rust-cache@v2
- name: Install Incan (cached)
uses: dannys-code-corner/incan/.github/actions/install-incan@main
with:
workspaces: incan

- name: Build Incan
working-directory: incan
run: cargo build --release

- name: Add Incan to PATH
run: echo "${{ github.workspace }}/incan/target/release" >> "$GITHUB_PATH"
incan-ref: main
incan-repo: dannys-code-corner/incan
runner-os: ${{ matrix.os }}

- name: Show toolchain
run: |
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Thank you for your interest in InQL — the typed relational layer for [Incan][i
## Getting started

1. **Install a matching Incan toolchain**
Build or install `incan` so it is on your `PATH` (start from the [Incan repository][incan-repo] and its contributor docs).
Build or install `incan` so it is on your `PATH` (start from the [Incan repository][incan-repo] and its contributor docs). The CI uses a **reusable composite action** that caches built binaries for faster subsequent runs.

2. **Clone this repository**

Expand Down Expand Up @@ -110,8 +110,8 @@ Open an issue on this repository for InQL-specific design or package questions;

<!-- Link references (single place for targets) -->

[incan-repo]: https://github.com/dannys-code-corner/incan-programming-language
[incan-contributing]: https://github.com/dannys-code-corner/incan-programming-language/blob/main/CONTRIBUTING.md
[incan-repo]: https://github.com/dannys-code-corner/incan
[incan-contributing]: https://github.com/dannys-code-corner/incan/blob/main/CONTRIBUTING.md
[readme]: README.md
[agents]: AGENTS.md
[architecture]: docs/architecture.md
Expand All @@ -122,5 +122,5 @@ Open an issue on this repository for InQL-specific design or package questions;
[issue-auto-label]: .github/workflows/issue_auto_label.yml
[pr-template]: .github/pull_request_template.md
[issue-templates]: .github/ISSUE_TEMPLATE/
[incan-docsite-loop]: https://github.com/dannys-code-corner/incan-programming-language/blob/main/workspaces/docs-site/docs/contributing/tutorials/book/08_docsite_contributor_loop.md
[incan-agents-docs-workflow]: https://github.com/dannys-code-corner/incan-programming-language/blob/main/AGENTS.md#docs-site-workflow-mkdocs-material
[incan-docsite-loop]: https://github.com/dannys-code-corner/incan/blob/main/workspaces/docs-site/docs/contributing/tutorials/book/08_docsite_contributor_loop.md
[incan-agents-docs-workflow]: https://github.com/dannys-code-corner/incan/blob/main/AGENTS.md#docs-site-workflow-mkdocs-material
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Normative proposals live under **[docs/rfcs/](docs/rfcs/README.md)**. InQL’s R
- `src/lib.incn` — public exports
- `src/` — library modules
- `tests/` — tests
- `.github/workflows/` — CI (builds Incan, then `make ci`)
- `.github/workflows/` — CI (uses reusable Incan composite action for caching)

Build and test from this repo root (with `incan` on your `PATH`):

Expand Down
5 changes: 2 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ Design records for the InQL project live in this directory.

- **RFCs (design proposals):** [docs/rfcs/](rfcs/README.md) — see the index for current numbered RFCs
- **How to write an RFC:** [contributing/writing_rfcs.md](contributing/writing_rfcs.md)
- **Research (non-normative):** [__research__](../__research__/README.md)

When a standalone docs site (e.g. **MkDocs Material**) is added, use `docs/` as the content root. **Conventions** (Divio-style structure, prose without hard wrapping, `mkdocs build --strict`, snippets) align with the Incan project: see [Incan docs-site contributor loop][incan-docsite-loop] and [Incan AGENTS — Docs-site workflow][incan-agents-docs-workflow].

<!-- FIXME: make this more akin to Incan's docs site -->

<!-- Link references -->

[incan-docsite-loop]: https://github.com/dannys-code-corner/incan-programming-language/blob/main/workspaces/docs-site/docs/contributing/tutorials/book/08_docsite_contributor_loop.md
[incan-agents-docs-workflow]: https://github.com/dannys-code-corner/incan-programming-language/blob/main/AGENTS.md#docs-site-workflow-mkdocs-material
[incan-docsite-loop]: https://github.com/dannys-code-corner/incan/blob/main/workspaces/docs-site/docs/contributing/tutorials/book/08_docsite_contributor_loop.md
[incan-agents-docs-workflow]: https://github.com/dannys-code-corner/incan/blob/main/AGENTS.md#docs-site-workflow-mkdocs-material
Loading
Loading