Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
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
1 change: 1 addition & 0 deletions .doccTargetList
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add one target per line
65 changes: 65 additions & 0 deletions .github/workflows/docc_deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: DocC Deploy

on:
workflow_call:
inputs:
docc_swift_version:
type: string
description: "Swift version used to generate DocC documentation."
default: "6.2"

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}-docc
cancel-in-progress: true


jobs:

generate-docc:
name: Generate DocC documentation
runs-on: ubuntu-latest

container:
image: swift:${{ inputs.docc_swift_version }}

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Install curl + jq
run: |
apt-get update -y
apt-get install -y curl jq

- name: Generate DocC documentation
run: |
curl -s https://raw.githubusercontent.com/BinaryBirds/github-workflows/refs/heads/feature/docc/scripts/generate-docc.sh | bash -s -- --name ${{ github.event.repository.name }}

- name: Upload DocC artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs


deploy:
name: Deploy DocC to GitHub Pages
needs: generate-docc
runs-on: ubuntu-latest

permissions:
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deploy.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deploy
uses: actions/deploy-pages@v4
23 changes: 21 additions & 2 deletions .github/workflows/extra_soundness.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,18 @@ on:
type: boolean
description: "Boolean to enable the local swift dependencies check job. Defaults to false."
default: false
headers_check_enabled:
type: boolean
description: "Checks Swift source file headers to ensure they follow the correct format. Defaults to false."
default: false
run_tests_with_cache_enabled:
type: boolean
description: "Boolean to enable run tests with .build cache."
default: false
run_tests_swift_versions:
type: string
description: "List of Swift versions to test with."
default: '["6.0", "6.1"]'
default: '["6.1", "6.2"]'
secrets:
SSH_PRIVATE_KEY:
required: false
Expand All @@ -35,7 +39,22 @@ jobs:
with:
persist-credentials: false
- name: Run local swift dependencies check
run: curl -s https://raw.githubusercontent.com/BinaryBirds/github-workflows/refs/heads/main/scripts/check-local-swift-dependencies.sh | bash
run: curl -s https://raw.githubusercontent.com/BinaryBirds/github-workflows/refs/heads/feature/docc/scripts/check-local-swift-dependencies.sh | bash


swift_headers_check:
name: Checks Swift source file headers
if: ${{ inputs.headers_check_enabled }}
runs-on: ubuntu-latest
timeout-minutes: 1
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Run swift headers check
run: curl -s https://raw.githubusercontent.com/BinaryBirds/github-workflows/refs/heads/feature/docc/scripts/check-swift-headers.sh | bash


cache-and-test:
name: Run tests with cache
Expand Down
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License
# MIT License

Copyright (c) 2024 Binary Birds Ltd.
Copyright (c) 2025 Binary Birds Ltd.

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
Expand Down
13 changes: 12 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,20 @@ breakage:
symlinks:
curl -s $(baseUrl)/check-broken-symlinks.sh | bash

## params: --local: generate for local testing
docc-generate:
curl -s $(baseUrl)/generate-docc.sh | bash

docc-local:
curl -s $(baseUrl)/generate-docc.sh | bash -s -- --local

docc-warnings:
curl -s $(baseUrl)/check-docc-warnings.sh | bash

## params: -n: name, -p: port
run-docc:
curl -s $(baseUrl)/run-docc-docker.sh | bash

headers:
curl -s $(baseUrl)/check-swift-headers.sh | bash

Expand Down Expand Up @@ -52,4 +63,4 @@ lint:
format:
curl -s $(baseUrl)/run-swift-format.sh | bash -s -- --fix

check: symlinks language deps lint
check: symlinks language deps lint docc-warnings headers
Loading