Skip to content

Commit cef3780

Browse files
authored
workflow changes, fix readme (#10)
1 parent 4d6b927 commit cef3780

4 files changed

Lines changed: 19 additions & 21 deletions

File tree

.github/workflows/deployment.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
tags:
66
- 'v*'
77
- '[0-9]*'
8+
workflow_dispatch:
89

910
jobs:
1011

.github/workflows/testing.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
format_check_enabled : true
1616
broken_symlink_check_enabled : true
1717
unacceptable_language_check_enabled : true
18-
shell_check_enabled : true
18+
shell_check_enabled : false
1919
docs_check_enabled : false
2020
api_breakage_check_enabled : false
2121
license_header_check_enabled : false
@@ -27,7 +27,7 @@ jobs:
2727
uses: BinaryBirds/github-workflows/.github/workflows/extra_soundness.yml@main
2828
with:
2929
local_swift_dependencies_check_enabled : true
30-
headers_check_enabled : true
30+
headers_check_enabled : false
3131
docc_warnings_check_enabled : true
3232

3333
swiftlang_tests:

Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@ SHELL=/bin/bash
22

33
baseUrl = https://raw.githubusercontent.com/BinaryBirds/github-workflows/refs/heads/main/scripts
44

5-
check: symlinks language deps lint docc-warnings headers
5+
check: symlinks language deps lint headers docc-warnings package
6+
7+
package:
8+
curl -s $(baseUrl)/check-swift-package.sh | bash
69

710
symlinks:
811
curl -s $(baseUrl)/check-broken-symlinks.sh | bash

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
An abstract mail component for Feather CMS.
44

5-
[
6-
![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138)
7-
](
5+
[![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138)](
86
https://github.com/feather-framework/feather-mail/releases/tag/1.0.0-beta.1
97
)
108

@@ -22,11 +20,11 @@ An abstract mail component for Feather CMS.
2220

2321
- Swift 6.1+
2422
- Platforms:
25-
- macOS 15+
26-
- iOS 18+
27-
- tvOS 18+
28-
- watchOS 11+
29-
- visionOS 2+
23+
- macOS 15+
24+
- iOS 18+
25+
- tvOS 18+
26+
- watchOS 11+
27+
- visionOS 2+
3028

3129
## Installation
3230

@@ -44,11 +42,7 @@ Then add `FeatherMail` to your target dependencies:
4442

4543
## Usage
4644

47-
[
48-
![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)
49-
](
50-
https://feather-framework.github.io/feather-mail/
51-
)
45+
[![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)](https://feather-framework.github.io/feather-mail/)
5246

5347
API documentation is available at the following link.
5448

@@ -59,16 +53,16 @@ API documentation is available at the following link.
5953

6054
The following mail driver implementations are available for use:
6155

62-
- [SES Driver](https://github.com/feather-framework/feather-mail-driver-ses)
63-
- [SMTP Driver](https://github.com/feather-framework/feather-mail-driver-smtp)
64-
- [Memory Driver](https://github.com/feather-framework/feather-memory-mail)
56+
- [SES Client](https://github.com/feather-framework/feather-mail-driver-ses)
57+
- [SMTP Client](https://github.com/feather-framework/feather-mail-driver-smtp)
58+
- [Memory Client](https://github.com/feather-framework/feather-memory-mail)
6559

6660
## Development
6761

6862
- Build: `swift build`
6963
- Test:
70-
- local: `make test`
71-
- using Docker: `make docker-test`
64+
- local: `make test`
65+
- using Docker: `make docker-test`
7266
- Format: `make format`
7367
- Check: `make check`
7468

0 commit comments

Comments
 (0)