https://github.com/eaceto/easwiftlibrarytemplate
A template for creating libraries for iOS, macOS, watchOS, tvOS (and possibly Linux!) with Swift
https://github.com/eaceto/easwiftlibrarytemplate
Last synced: about 1 year ago
JSON representation
A template for creating libraries for iOS, macOS, watchOS, tvOS (and possibly Linux!) with Swift
- Host: GitHub
- URL: https://github.com/eaceto/easwiftlibrarytemplate
- Owner: eaceto
- License: mit
- Created: 2022-06-08T09:34:39.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-15T20:12:13.000Z (about 4 years ago)
- Last Synced: 2025-03-29T07:52:05.363Z (about 1 year ago)
- Language: Shell
- Size: 2.58 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Swift Library Template
A template for creating libraries for iOS, macOS, watchOS, tvOS (and possibly Linux!) with Swift
1. [Getting Started](#getting-started)
2. [Run (one time) Setup Script](#run-one-time-setup-script)
3. [Documenting Source Code](#documenting-source-code)
4. [Pipeline](#pipeline)
## Getting Started
Getting started is as easy as [creating a GitHub project](https://github.com/eaceto/EASwiftLibraryTemplate/generate) using this template, and including **all branches**.
### Setup your GitHub Page
GitHub Page is used to render source code and other automatically generated documentation. Automatically generated documentation includes:
* Source Code Documentation
* (Swift)Linter Report
* Code Coverage Report
This docs are automatically generated when the **CD** workflow runs.
Please, take into consideration that your GitHub Page should point to **main** branch and **/docs** folders.
## Run *one time* Setup Script
From your terminal run:
```sh
/bin/zsh -c "$(curl -fsSL https://gist.githubusercontent.com/eaceto/743a8bbdb0696be36c2c03142002626f/raw/setup.sh)"
```
The script will ask for:
* Library Name
* Initial library version
* Jazzy or DocC for documentation
And then check if the information is ok.
```sh
Enter the Library name without spaces (i.e.: MySuperProLibrary).
This will also be the Target and Product name of the Swift library.
MySuperLib
Enter the initial version of your Library in SemVer format (x.y.z)
1.3.5
Do you want to use 'docs' instead of 'jazzy' as docs generator (BETA) [y/N]?
====== Configuration to apply ======
Please verify that the following information is correct
Library name: 'MySuperLib'
Library initial version: '1.3.5'
Library homepage url: 'https://github.com/eaceto/EASwiftLibraryTemplate'
Library repository url (SSH): 'git@github.com:eaceto/EASwiftLibraryTemplate.git'
Library repository url (HTTPS): 'https://github.com/eaceto/EASwiftLibraryTemplate.git'
Library GitHub Page: 'https://eaceto.github.io/EASwiftLibraryTemplate/'
Docs using: 'jazzy'
====================================
Is this information correct? [y/N]
```
When you confirm that the information is correct, several steps will be taken in order to adapt the template to your project.
Then, you can build and test the library, and if everything is okey commit.
## Documenting Source Code
Documentation is automatically generated using **Jazzy** or **DocC**, and published to GitHub Page. By default GitHub Page **index.md** refers to **Jazzy** documentation, but you can switch it to **DocC** easily. This change can be done in **definitions.json** file, where **docs_generator** accepts **jazzy** or **docc** as valid values.
```json
{
"name": "EASwiftLibraryTemplate",
"version": "0.0.3",
"homepage": "https://github.com/eaceto/EASwiftLibraryTemplate",
"git": "https://github.com/eaceto/EASwiftLibraryTemplate.git",
"docs_generator": "jazzy"
}
```
In order to know more about Jazzy refer to its [GitHub Repository](https://github.com/realm/jazzy), and if you would like to use DocC please take a look at the [project documentation](https://developer.apple.com/documentation/docc).
## Pipeline
GitHub Actions are used in this template, not only for documentation but also for CI/CD tasks.
The action defined in **ci.yml** will **build** and **test** the library using Swift v5.5 and v5.6.
If you need to add/remove a version of Swift, or add **ubuntu** as a target platform, modify the Strategy declared in **ci.yml**
```yml
strategy:
matrix:
os: [macos-latest] ## Add 'ubuntu-latest' if required
swift: ["5.5", "5.6"]
```
By default, all pipelines run on branch **main**. Modify the GitHub Actions in order to make it run on other branches. For example, CI can run on main and development branch by changing the following lines in .github/workflows/ci.yml:
From this:
```yml
name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
```
To this:
```yml
name: CI
on:
push:
branches: [main, development]
pull_request:
branches: [main, development]
workflow_dispatch:
```