From 1591c0e58584769c4aa305c8fc1ac649ce146d90 Mon Sep 17 00:00:00 2001 From: Moritz Lang Date: Sun, 7 May 2023 15:02:20 +0700 Subject: [PATCH] Host documentation on Swift Package Index --- .github/workflows/documentation.yaml | 31 ---------------------------- .spi.yml | 4 ++++ README.md | 2 +- 3 files changed, 5 insertions(+), 32 deletions(-) delete mode 100644 .github/workflows/documentation.yaml create mode 100644 .spi.yml diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml deleted file mode 100644 index 219046d..0000000 --- a/.github/workflows/documentation.yaml +++ /dev/null @@ -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 diff --git a/.spi.yml b/.spi.yml new file mode 100644 index 0000000..4a71094 --- /dev/null +++ b/.spi.yml @@ -0,0 +1,4 @@ +version: 1 +builder: + configs: + - documentation_targets: [OpenTelemetryXRay] diff --git a/README.md b/README.md index ddd3eac..ab55e43 100644 --- a/README.md +++ b/README.md @@ -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).