Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate docs content to Pages #207

Merged
merged 24 commits into from
Dec 20, 2023
Merged
Show file tree
Hide file tree
Changes from 23 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
57 changes: 57 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Deploy docs content to Pages 2
humanagent marked this conversation as resolved.
Show resolved Hide resolved

on:
push:
branches: ["docs_build_v1"]
humanagent marked this conversation as resolved.
Show resolved Hide resolved
workflow_dispatch:

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

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: macos-12
steps:
- uses: actions/checkout@v3

- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.0

- name: Cache Ruby gems
uses: actions/cache@v2
with:
path: vendor/bundle
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
restore-keys: |
${{ runner.os }}-gems-

- name: Install Jazzy
run: |
bundle config path vendor/bundle
bundle add jazzy

- name: Generate documentation
run: bundle exec jazzy --output ./docs --theme=fullwidth

- name: Setup Pages
uses: actions/configure-pages@v3

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: "./docs"

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
source 'https://rubygems.org'
gem 'jazzy'
Comment on lines +1 to +2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know enough about iOS development to know if this would be an issue cc @nakajima

Copy link
Contributor Author

@humanagent humanagent Dec 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm trying to speed it up a bit. This file is caching jazzy and saving almost 1.5min. Doesn't have that much of an impact so i can delete it if can cause potential conflicts.

CleanShot 2023-12-08 at 09 17 08@2x

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine to me.

2 changes: 1 addition & 1 deletion Sources/XMTP/Client.swift
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public struct ClientOptions {
}
}

/// Client is the entrypoint into the XMTP SDK.
/// Client is the entrypoint into the XMTP SDK. v2
humanagent marked this conversation as resolved.
Show resolved Hide resolved
///
/// A client is created by calling ``create(account:options:)`` with a ``SigningKey`` that can create signatures on your behalf. The client will request a signature in two cases:
///
Expand Down