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

CONFIG: Add Swift Package Index config #103

Merged
merged 7 commits into from
Jul 28, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
9 changes: 0 additions & 9 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,6 @@ jobs:
key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
restore-keys: |
${{ runner.os }}-spm-

- name: Lint
run: swiftlint --strict --reporter github-actions-logging

- name: Build
run: swift build -Xswiftc -warnings-as-errors --build-tests
Expand Down Expand Up @@ -83,11 +80,5 @@ jobs:
restore-keys: |
${{ runner.os }}-spm-

- name: Install markdownlint-cli
run: brew install markdownlint-cli

- name: Lint DocC files
run: markdownlint **/*.docc/**/*.md

- name: Build
run: swift package generate-documentation --product TMDb
4 changes: 2 additions & 2 deletions .github/workflows/code-scan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ on:
branches:
- main
schedule:
# Every day at 12am
- cron: '0 0 * * *'
# Every Sunday at 12am
- cron: '0 0 * * 0'
workflow_dispatch:

concurrency:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
push:
branches:
- main
paths:
- '**.docc'
workflow_dispatch:

permissions:
Expand Down
44 changes: 44 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Lint

on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:

concurrency:
group: "lint-${{ github.head_ref || github.run_id }}"
cancel-in-progress: true

env:
DEVELOPER_DIR: /Applications/Xcode_14.3.1.app/Contents/Developer

jobs:
swiftlint:
name: Swiftlint
runs-on: macos-13
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Swiftlint
run: swiftlint --strict --reporter github-actions-logging

markdownlint:
name: Markdown lint
runs-on: macos-13
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install markdownlint-cli
run: brew install markdownlint-cli

- name: Lint README
run: markdownlint README.md

- name: Lint DocC files
run: markdownlint **/*.docc/**/*.md
3 changes: 3 additions & 0 deletions .spi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
version: 1
external_links:
documentation: "https://adamayoung.github.io/TMDb/documentation/tmdb/"
4 changes: 4 additions & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,

* @adamayoung
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@ A Swift Package for The Movie Database (TMDb) <https://www.themoviedb.org>

* Swift 5.7+
* OS
* macOS 10.15+
* iOS 13+
* watchOS 6+
* tvOS 13+
* macOS 11+
* iOS 14+
* watchOS 7+
* tvOS 14+

## Installation

### [Swift Package Manager](https://github.com/apple/swift-package-manager)

Add the TMDb package as a dependency to your `Package.swift` file, and add it as a dependency to your target.
Add the TMDb package as a dependency to your `Package.swift` file, and add it
as a dependency to your target.

```swift
// swift-tools-version:5.7
Expand Down Expand Up @@ -47,7 +48,8 @@ Add the TMDb package to your Project's Package dependencies.

### Get an API Key

Create an API key from The Movie Database web site [https://www.themoviedb.org/documentation/api](https://www.themoviedb.org/documentation/api).
Create an API key from The Movie Database web site
[https://www.themoviedb.org/documentation/api](https://www.themoviedb.org/documentation/api).

## Documentation

Expand All @@ -61,4 +63,5 @@ Documentation and examples of usage can be found at

## License

This library is licensed under the Apache License 2.0. See [LICENSE](https://github.com/adamayoung/TMDb/blob/main/LICENSE) for details.
This library is licensed under the Apache License 2.0. See
[LICENSE](https://github.com/adamayoung/TMDb/blob/main/LICENSE) for details.