Host documentation on Swift Package Index

This commit is contained in:
Moritz Lang 2023-05-07 15:02:20 +07:00
parent 65652f6400
commit 1591c0e585
No known key found for this signature in database
GPG Key ID: 4F0F1E11ECABAFC1
3 changed files with 5 additions and 32 deletions

View File

@ -1,31 +0,0 @@
name: Documentation
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Generate Documentation
uses: SwiftDocOrg/swift-doc@master
with:
format: html
base-url: /opentelemetry-swift-xray/
module-name: "OpenTelemetry Swift X-Ray"
output: Documentation
- name: Update Permissions
run: 'sudo chown -R $USER Documentation'
- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@4.1.0
with:
branch: gh-pages
folder: Documentation

4
.spi.yml Normal file
View File

@ -0,0 +1,4 @@
version: 1
builder:
configs:
- documentation_targets: [OpenTelemetryXRay]

View File

@ -1,7 +1,7 @@
# X-Ray Support for OpenTelemetry Swift
[![CI](https://github.com/slashmo/opentelemetry-swift-xray/actions/workflows/ci.yaml/badge.svg)](https://github.com/slashmo/opentelemetry-swift-xray/actions/workflows/ci.yaml)
[![Swift 5.7](https://img.shields.io/badge/Swift-5.7-%23f05137)](https://swift.org)
[![Swift support](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fslashmo%2Fswift-otel%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/slashmo/swift-otel)
[![Made for Swift Distributed Tracing](https://img.shields.io/badge/Made%20for-Swift%20Distributed%20Tracing-%23f05137)](https://github.com/apple/swift-distributed-tracing)
This library adds support for [AWS X-Ray](https://aws.amazon.com/xray/) to [OpenTelemetry Swift](https://github.com/slashmo/opentelemetry-swift).