Skip to content

Commit 22b569a

Browse files
ns-vasilevns-vasilev
authored
Release 2.0.0 (#4)
* Update `README.md` * Add `CHANGELOG.md` * Update `Makefile` * Implement `async` requests * Revise the documentation for the methods. * Update `pre-commit` hooks - Integrate `SwiftLint` for validating modified lines. * Resolve `SwiftLint` warnings * Implement `ReceiptRefreshProvider` tests * Increase project's test-coverage * Update comments * Rewrite `async/await` blocks * Refactor test's target structure * Update method names and improve the documentation * Implement `SKProductTests` * Update package's documentation * Integrate `CodeCov` * Integrate `SwiftLint` validation into GitHub Actions * Update `Usage.md` layout * Update `CHANGELOG.md` * Update `ci.yml` * Increase the `tvOS` version to `13.0` * Update `README.md` * Update `ci.yml` * `Codecov` Integration [#2] * Update `README.md` * Create `dependabot.yml` * Update GitHub workflow (#3) * Implement issues and PR templates * Update `README.md`
1 parent 82c284c commit 22b569a

File tree

64 files changed

+2238
-589
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+2238
-589
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: "🐛 Bug Report"
3+
about: Report a reproducible bug or regression.
4+
title: 'Bug: '
5+
labels: 'bug'
6+
7+
---
8+
9+
<!--
10+
Please provide a clear and concise description of what the bug is. Include
11+
screenshots if needed. Please test using the latest version of the relevant
12+
React packages to make sure your issue has not already been fixed.
13+
-->
14+
15+
Application version:
16+
17+
## Steps To Reproduce
18+
19+
1.
20+
2.
21+
22+
<!--
23+
Your bug will get fixed much faster if we can run your code and it doesn't
24+
have dependencies other than React. Issues without reproduction steps or
25+
code examples may be immediately closed as not actionable.
26+
-->
27+
28+
Link to code example:
29+
30+
<!--
31+
Please provide a CodeSandbox (https://codesandbox.io/s/new), a link to a
32+
repository on GitHub, or provide a minimal code example that reproduces the
33+
problem. You may provide a screenshot of the application if you think it is
34+
relevant to your bug report. Here are some tips for providing a minimal
35+
example: https://stackoverflow.com/help/mcve.
36+
-->
37+
38+
## The current behavior
39+
40+
41+
## The expected behavior

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: 🛠 Feature request
3+
about: If you have a feature request for the Firebase iOS SDK, file it here.
4+
labels: 'type: enhancement'
5+
---
6+
7+
**Feature description**
8+
Clearly and concisely describe the feature.
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.

‎.github/PULL_REQUEST_TEMPLATE/bug_template.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Bug description
2+
Clearly and concisely describe the problem.
3+
4+
## Solution description
5+
Describe your code changes in detail for reviewers. Explain the technical solution you have provided and how it fixes the issue case.
6+
7+
## Covered unit test cases
8+
- [x] yes
9+
- [x] no

‎.github/PULL_REQUEST_TEMPLATE/feature_template.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Feature description
2+
Clearly and concisely describe the feature.
3+
4+
## Solution description
5+
Describe your code changes in detail for reviewers.
6+
7+
## Areas affected and ensured
8+
List out the areas affected by your code changes.
9+
10+
## Covered unit test cases
11+
- [x] yes
12+
- [x] no

‎.github/dependabot.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "swift" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "daily"

‎.github/workflows/ci.yml‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,27 @@ on:
66
- main
77
- dev
88
pull_request:
9-
branches: [ main ]
9+
paths:
10+
- '.swiftlint.yml'
11+
branches:
12+
- main
13+
- dev
1014

1115
concurrency:
1216
group: ci
1317
cancel-in-progress: true
1418

1519
jobs:
20+
SwiftLint:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v3
24+
- name: GitHub Action for SwiftLint
25+
uses: norio-nomura/[email protected]
26+
with:
27+
args: --strict
28+
env:
29+
DIFF_BASE: ${{ github.base_ref }}
1630
Latest:
1731
name: Test Latest (iOS, macOS, tvOS, watchOS)
1832
runs-on: macOS-12
@@ -26,16 +40,26 @@ jobs:
2640
- destination: "OS=16.1,name=iPhone 14 Pro"
2741
name: "iOS"
2842
scheme: "Flare"
43+
sdk: iphonesimulator
2944
- destination: "OS=16.1,name=Apple TV"
3045
name: "tvOS"
3146
scheme: "Flare"
47+
sdk: appletvsimulator
3248
- destination: "OS=9.1,name=Apple Watch Series 8 (45mm)"
3349
name: "watchOS"
3450
scheme: "Flare"
51+
sdk: watchsimulator
3552
- destination: "platform=macOS"
3653
name: "macOS"
3754
scheme: "Flare"
55+
sdk: macosx
3856
steps:
3957
- uses: actions/checkout@v3
4058
- name: ${{ matrix.name }}
41-
run: xcodebuild test -scheme "${{ matrix.scheme }}" -destination "${{ matrix.destination }}" clean
59+
run: xcodebuild test -scheme "${{ matrix.scheme }}" -destination "${{ matrix.destination }}" clean -enableCodeCoverage YES -resultBundlePath "./${{ matrix.sdk }}.xcresult" | xcpretty -r junit
60+
- name: Upload coverage reports to Codecov
61+
uses: codecov/[email protected]
62+
with:
63+
token: ${{ secrets.CODECOV_TOKEN }}
64+
xcode: true
65+
xcode_archive_path: "./${{ matrix.sdk }}.xcresult"

‎.swiftlint.yml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,10 @@ disabled_rules:
1313
opt_in_rules: # some rules are only opt-in
1414
- anyobject_protocol
1515
- array_init
16-
- attributes
1716
- closure_body_length
1817
- closure_end_indentation
1918
- closure_spacing
2019
- collection_alignment
21-
- conditional_returns_on_newline
2220
- contains_over_filter_count
2321
- contains_over_filter_is_empty
2422
- contains_over_first_not_nil
@@ -131,4 +129,7 @@ nesting:
131129
type_name:
132130
max_length:
133131
warning: 40
134-
error: 50
132+
error: 50
133+
134+
file_name:
135+
excluded: ["Types.swift"]

‎.swiftpm/xcode/xcshareddata/xcschemes/Flare.xcscheme‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<Scheme
3+
LastUpgradeVersion = "1410"
4+
version = "1.3">
5+
<BuildAction
6+
parallelizeBuildables = "YES"
7+
buildImplicitDependencies = "YES">
8+
<BuildActionEntries>
9+
<BuildActionEntry
10+
buildForTesting = "YES"
11+
buildForRunning = "YES"
12+
buildForProfiling = "YES"
13+
buildForArchiving = "YES"
14+
buildForAnalyzing = "YES">
15+
<BuildableReference
16+
BuildableIdentifier = "primary"
17+
BlueprintIdentifier = "Flare"
18+
BuildableName = "Flare"
19+
BlueprintName = "Flare"
20+
ReferencedContainer = "container:">
21+
</BuildableReference>
22+
</BuildActionEntry>
23+
<BuildActionEntry
24+
buildForTesting = "YES"
25+
buildForRunning = "YES"
26+
buildForProfiling = "NO"
27+
buildForArchiving = "NO"
28+
buildForAnalyzing = "YES">
29+
<BuildableReference
30+
BuildableIdentifier = "primary"
31+
BlueprintIdentifier = "FlareTests"
32+
BuildableName = "FlareTests"
33+
BlueprintName = "FlareTests"
34+
ReferencedContainer = "container:">
35+
</BuildableReference>
36+
</BuildActionEntry>
37+
</BuildActionEntries>
38+
</BuildAction>
39+
<TestAction
40+
buildConfiguration = "Debug"
41+
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
42+
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
43+
shouldUseLaunchSchemeArgsEnv = "YES"
44+
codeCoverageEnabled = "YES"
45+
onlyGenerateCoverageForSpecifiedTargets = "YES">
46+
<CodeCoverageTargets>
47+
<BuildableReference
48+
BuildableIdentifier = "primary"
49+
BlueprintIdentifier = "Flare"
50+
BuildableName = "Flare"
51+
BlueprintName = "Flare"
52+
ReferencedContainer = "container:">
53+
</BuildableReference>
54+
</CodeCoverageTargets>
55+
<Testables>
56+
<TestableReference
57+
skipped = "NO">
58+
<BuildableReference
59+
BuildableIdentifier = "primary"
60+
BlueprintIdentifier = "FlareTests"
61+
BuildableName = "FlareTests"
62+
BlueprintName = "FlareTests"
63+
ReferencedContainer = "container:">
64+
</BuildableReference>
65+
</TestableReference>
66+
</Testables>
67+
</TestAction>
68+
<LaunchAction
69+
buildConfiguration = "Debug"
70+
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
71+
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
72+
launchStyle = "0"
73+
useCustomWorkingDirectory = "NO"
74+
ignoresPersistentStateOnLaunch = "NO"
75+
debugDocumentVersioning = "YES"
76+
debugServiceExtension = "internal"
77+
allowLocationSimulation = "YES">
78+
</LaunchAction>
79+
<ProfileAction
80+
buildConfiguration = "Release"
81+
shouldUseLaunchSchemeArgsEnv = "YES"
82+
savedToolIdentifier = ""
83+
useCustomWorkingDirectory = "NO"
84+
debugDocumentVersioning = "YES">
85+
<MacroExpansion>
86+
<BuildableReference
87+
BuildableIdentifier = "primary"
88+
BlueprintIdentifier = "Flare"
89+
BuildableName = "Flare"
90+
BlueprintName = "Flare"
91+
ReferencedContainer = "container:">
92+
</BuildableReference>
93+
</MacroExpansion>
94+
</ProfileAction>
95+
<AnalyzeAction
96+
buildConfiguration = "Debug">
97+
</AnalyzeAction>
98+
<ArchiveAction
99+
buildConfiguration = "Release"
100+
revealArchiveInOrganizer = "YES">
101+
</ArchiveAction>
102+
</Scheme>

‎CHANGELOG.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# Change Log
22
All notable changes to this project will be documented in this file.
33

4+
#### 2.x Releases
5+
- `2.0.x` Releases - [2.0.0](#200)
6+
7+
## [2.0.0](https://github.com/space-code/flare/releases/tag/2.0.0)
8+
Released on 2023-09-13.
9+
10+
#### Added
11+
- Support for Swift Concurrency, including async-await for requests.
12+
13+
#### Updated
14+
- Rename public methods and parameters to increase readability.
15+
416
#### 1.x Releases
517
- `1.0.x` Releases - [1.0.0](#100)
618

‎Documentation/Resources/flare.png‎

319 KB
Loading

0 commit comments

Comments
 (0)