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

[Docs] Build docs using jazzy #3016

Merged
merged 19 commits into from
Jan 8, 2020
Merged

[Docs] Build docs using jazzy #3016

merged 19 commits into from
Jan 8, 2020

Conversation

jpsim
Copy link
Collaborator

@jpsim jpsim commented Jan 6, 2020

  • Add .jazzy.yaml configuration file
  • Update swiftlint generate-docs to write docs to a directory rather than a single file
  • Add jazzy to the Gemfile
  • Run bundle update
  • Add GitHub Actions workflow to run jazzy automatically and publish to GitHub Pages

swiftlint-jazzy

@jpsim
Copy link
Collaborator Author

jpsim commented Jan 6, 2020

😞

Workflows can't be executed on this repository. Please check your payment method or billing status.

https://github.com/realm/SwiftLint/pull/3016/checks?check_run_id=375100213

@jpsim
Copy link
Collaborator Author

jpsim commented Jan 6, 2020

Apparently, GitHubActions aren't available to orgs that pay GitHub but are on "legacy" plan.

https://twitter.com/webKnjaZ/status/1194964915506831362

@realm realm deleted a comment from SwiftLintBot Jan 6, 2020
@realm realm deleted a comment from SwiftLintBot Jan 6, 2020
@realm realm deleted a comment from SwiftLintBot Jan 6, 2020
@SwiftLintBot
Copy link

SwiftLintBot commented Jan 6, 2020

1 Warning
⚠️ Big PR
12 Messages
📖 Linting Aerial with this PR took 1.21s vs 1.17s on master (3% slower)
📖 Linting Alamofire with this PR took 2.19s vs 2.2s on master (0% faster)
📖 Linting Firefox with this PR took 9.07s vs 8.91s on master (1% slower)
📖 Linting Kickstarter with this PR took 14.63s vs 14.57s on master (0% slower)
📖 Linting Moya with this PR took 1.19s vs 1.12s on master (6% slower)
📖 Linting Nimble with this PR took 1.36s vs 1.34s on master (1% slower)
📖 Linting Quick with this PR took 0.54s vs 0.54s on master (0% slower)
📖 Linting Realm with this PR took 2.34s vs 2.37s on master (1% faster)
📖 Linting SourceKitten with this PR took 0.98s vs 0.98s on master (0% slower)
📖 Linting Sourcery with this PR took 6.79s vs 6.71s on master (1% slower)
📖 Linting Swift with this PR took 12.33s vs 12.32s on master (0% slower)
📖 Linting WordPress with this PR took 14.69s vs 14.78s on master (0% faster)

Generated by 🚫 Danger

@jpsim
Copy link
Collaborator Author

jpsim commented Jan 6, 2020

Only thing left is to automatically push to the gh-pages branch from the CI job.

* Add `.jazzy.yaml` configuration file
* Update `swiftlint generate-docs` to write docs to a directory rather
  than a single file
* Add jazzy to the Gemfile
* Run `bundle update`
* Add GitHub Actions workflow to run jazzy automatically and publish to
  GitHub Pages
Still missing the actually publishing to GitHub Pages though.
The one vendored in the jazzy gem is built for macOS.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants