Skip to content

Commit 6d98bcc

Browse files
ianwowianwow
authored
add v0.5.2 release to github (#15)
1 parent 23b56eb commit 6d98bcc

28 files changed

+382
-159
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior.
14+
15+
**Expected behavior**
16+
A clear and concise description of what you expected to happen.
17+
18+
**Please complete the following information about the Clickstream Analytics on AWS solution and the Clickstream Flutter SDK:**
19+
20+
- [ ] Clickstream Analytics on AWS version: [e.g. 1.1.8]
21+
- [ ] Clickstream Flutter SDK version: [e.g. 0.5.2]
22+
23+
To get the version of the solution, you can look at the description of the created CloudFormation stack. For example, "_(SO0219) Clickstream Analytics on AWS (Version v1.1.8)(Build 202411122303)- Control Plane_".
24+
25+
To get the version of the solution, look in your pubspec.yaml or pubspec.lock file for the `clickstream_analytics` dependency. For example,
26+
27+
```
28+
clickstream_analytics:
29+
clickstream_flutter: ^0.5.2
30+
```
31+
32+
- [ ] Region: [e.g. us-east-1]
33+
- [ ] Was the solution modified from the version published on this repository?
34+
- [ ] If the answer to the previous question was yes, are the changes available on GitHub?
35+
- [ ] Were there any errors in the CloudWatch Logs?
36+
37+
**Screenshots**
38+
If applicable, add screenshots to help explain your problem (please **DO NOT include sensitive information**).
39+
40+
**Additional context**
41+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this solution
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the feature you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Additional context**
16+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/general-issues.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: "\U00002753 General Issue"
3+
about: Create a new issue
4+
title: ""
5+
labels: needs-triage, guidance
6+
---
7+
8+
## :question: General Issue
9+
10+
### The Question
11+
<!--
12+
Ask your question here. Include any details relevant. Make sure you are not falling prey to the [X/Y problem][2]!
13+
14+
[2]: http://xyproblem.info
15+
-->
16+
17+
### Other information
18+
<!-- e.g. detailed explanation, stacktraces, related issues, suggestions on how to fix, links for us to have context, eg. associated pull-request, stackoverflow, gitter, etc -->

‎.github/PULL_REQUEST_TEMPLATE.md

+3-14
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,5 @@
1-
## Issue \#
2-
<!-- If applicable, please link to issue(s) this change addresses -->
1+
**Issue #, if available:**
32

4-
## Description
5-
<!-- Why is this change required? What problem does it solve? -->
3+
**Description of changes:**
64

7-
## General Checklist
8-
<!-- Check or cross out if not relevant -->
9-
10-
- [ ] Added new tests to cover change, if needed
11-
- [ ] Security oriented best practices and standards are followed (e.g. using input sanitization, principle of least privilege, etc)
12-
- [ ] Documentation update for the change if required
13-
- [ ] PR title conforms to conventional commit style
14-
- [ ] If breaking change, documentation/changelog update with migration instructions
15-
16-
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
5+
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

‎.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
.buildlog/
99
.history
1010
.svn/
11+
.symlinks
1112
migrate_working_dir/
13+
deployment/open-source/
1214

1315
# IntelliJ related
1416
*.iml
@@ -23,7 +25,7 @@ migrate_working_dir/
2325

2426
# Flutter/Dart/Pub related
2527
# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
26-
/pubspec.lock
28+
**/pubspec.lock
2729
**/doc/api/
2830
.dart_tool/
2931
.packages

‎.pubignore

+7-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ coverage
44
build
55
android/src/test
66
ios/Clickstream/*
7-
!ios/Clickstream/Sources
7+
ios/.symlinks/*
88
example/integration_test
99
example/test
10-
release.sh
10+
release.sh
11+
# Files containing proprietary development and testing code - DO NOT PUBLISH:
12+
deployment
13+
buildspec.yml
14+
sonar-project.properties
15+
solution-manifest.yaml

‎CHANGELOG.md

+50-9
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,71 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## 0.5.2
9+
10+
### Changed
11+
* Relocated repository from awslabs to aws-solutions
12+
* Upgraded Gradle from 7.5 to 8.3
13+
* Updated CocoaPods from 1.15.2 to 1.16.2
14+
15+
### Security
16+
* Addressed and resolved various CVE vulnerabilities
17+
18+
### Removed
19+
* Removed all github workflows
20+
21+
## 0.5.1
22+
23+
### Changed
24+
25+
* bump Swift SDK to v0.12.5
26+
127
## 0.5.0
228

3-
* feat: bump Android SDK to v0.14.0 and bump Swift SDK to v0.12.4
29+
### Added
30+
31+
* bump Android SDK to v0.14.0 and bump Swift SDK to v0.12.4
432

533
## 0.4.2
634

7-
* fix: crash when converting invalid JSON object on Swift SDK
35+
### Fixed
36+
37+
* crash when converting invalid JSON object on Swift SDK
838

939
## 0.4.1
1040

11-
* fix: the issue when initialize SDK without global attribute
41+
### Fixed
42+
43+
* defect when initializing the SDK without a global attribute
1244

1345
## 0.4.0
1446

15-
* feat: add preset traffic source attributes
47+
### Added
48+
49+
* add preset traffic source attributes
1650

1751
## 0.3.0
1852

19-
* feat: add record screen view api
53+
### Added
54+
55+
* add record screen view api
2056

2157
## 0.2.0
2258

23-
* feat: support record items with custom attributes.
59+
### Added
60+
61+
* support record items with custom attributes.
2462

25-
### Pipeline version compatible
26-
Need use pipeline version 1.1.x and above
63+
### Changed
64+
65+
* This version introduces the requirement to use a backend from Clickstream version 1.1.x or later.
2766

2867
## 0.1.0
2968

30-
* feat: add basic android and swift SDK APIs.
69+
### Added
70+
71+
* add basic android and swift SDK APIs.

‎CONTRIBUTING.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,23 @@ documentation, we greatly value feedback and contributions from our community.
66
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
77
information to effectively respond to your bug report or contribution.
88

9-
109
## Reporting Bugs/Feature Requests
1110

1211
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1312

14-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
13+
When filing an issue, please check [existing open](https://github.com/aws-solutions/clickstream-flutter/issues), or [recently closed](https://github.com/aws-solutions/clickstream-flutter/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
1514
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1615

17-
* A reproducible test case or series of steps
18-
* The version of our code being used
19-
* Any modifications you've made relevant to the bug
20-
* Anything unusual about your environment or deployment
21-
16+
- A reproducible test case or series of steps
17+
- The version of our code being used
18+
- Any modifications you've made relevant to the bug
19+
- Anything unusual about your environment or deployment
2220

2321
## Contributing via Pull Requests
22+
2423
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
2524

26-
1. You are working against the latest source on the *main* branch.
25+
1. You are working against the latest source on the _main_ branch.
2726
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
2827
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
2928

@@ -39,21 +38,22 @@ To send us a pull request, please:
3938
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4039
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4140

42-
4341
## Finding contributions to work on
44-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
4542

43+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws-solutions/clickstream-flutter/labels/help%20wanted) issues is a great place to start.
4644

4745
## Code of Conduct
46+
4847
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
4948
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
5049
[email protected] with any additional questions or comments.
5150

52-
5351
## Security issue notifications
54-
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
5552

53+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
5654

5755
## Licensing
5856

59-
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
57+
See the [LICENSE](https://github.com/aws-solutions/clickstream-flutter/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
58+
59+
We may ask you to sign a [Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

‎NOTICE

-1
This file was deleted.

‎NOTICE.txt

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Clickstream Analytics on AWS Flutter SDK
2+
3+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
4+
Licensed under the Apache License Version 2.0 (the "License"). You may not use this file except
5+
in compliance with the License. A copy of the License is located at http://www.apache.org/licenses/
6+
or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS,
7+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied. See the License for the
8+
specific language governing permissions and limitations under the License.
9+
10+
**********************
11+
THIRD PARTY COMPONENTS
12+
**********************
13+
14+
This software includes third party software subject to the following copyrights:
15+
16+
async under the BSD-3-Clause license.
17+
boolean_selector under the BSD-3-Clause license.
18+
characters under the BSD-3-Clause license.
19+
clock under the Apache-2.0 license.
20+
collection under the BSD-3-Clause license.
21+
fake_async under the Apache-2.0 license.
22+
flutter_lints under the BSD-3-Clause license.
23+
flutter_test under the BSD-3-Clause license.
24+
leak_tracker under the BSD-3-Clause license.
25+
leak_tracker_flutter_testing under the BSD-3-Clause license.
26+
leak_tracker_testing under the BSD-3-Clause license.
27+
lints under the BSD-3-Clause license.
28+
matcher under the BSD-3-Clause license.
29+
material_color_utilities under the Apache-2.0 license.
30+
meta under the BSD-3-Clause license.
31+
path under the BSD-3-Clause license.
32+
plugin_platform_interface under the BSD-3-Clause license.
33+
source_span under the BSD-3-Clause license.
34+
stack_trace under the BSD-3-Clause license.
35+
stream_channel under the BSD-3-Clause license.
36+
string_scanner under the BSD-3-Clause license.
37+
term_glyph under the BSD-3-Clause license.
38+
test_api under the BSD-3-Clause license.
39+
vector_math under the Zlib license.
40+
vm_service under the BSD-3-Clause license.
41+
clickstream_analytics under the Apache-2.0 license.
42+
cupertino_icons under the MIT license.
43+
file under the BSD-3-Clause license.
44+
fuchsia_remote_debug_protocol under the BSD-3-Clause license.
45+
platform under the BSD-3-Clause license.
46+
process under the BSD-3-Clause license.
47+
sync_http under the BSD-3-Clause license.
48+
webdriver under the Apache-2.0 license.
49+
50+
********************
51+
OPEN SOURCE LICENSES
52+
********************
53+
54+
Apache-2.0 - https://spdx.org/licenses/Apache-2.0.html
55+
BSD-3-Clause - https://spdx.org/licenses/BSD-3-Clause.html
56+
MIT - https://spdx.org/licenses/MIT.html
57+
Zlib - https://spdx.org/licenses/Zlib.html

‎README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
# AWS Solution Clickstream Analytics SDK for Flutter
2-
[![clickstream-flutter-test](https://github.com/awslabs/clickstream-flutter/actions/workflows/test.yml/badge.svg)](https://github.com/awslabs/clickstream-flutter/actions/workflows/test.yml) [![clickstream-flutter-release](https://github.com/awslabs/clickstream-flutter/actions/workflows/release.yml/badge.svg)](https://github.com/awslabs/clickstream-flutter/actions/workflows/release.yml) [![clickstream-flutter-build-android](https://github.com/awslabs/clickstream-flutter/actions/workflows/build-android.yml/badge.svg)](https://github.com/awslabs/clickstream-flutter/actions/workflows/build-android.yml) [![clickstream-flutter-build-ios](https://github.com/awslabs/clickstream-flutter/actions/workflows/build-ios.yml/badge.svg)](https://github.com/awslabs/clickstream-flutter/actions/workflows/build-ios.yml) [![pub package](https://img.shields.io/pub/v/clickstream_analytics.svg)](https://pub.dev/packages/clickstream_analytics) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
3-
42

53
## Introduction
64

7-
Clickstream Flutter SDK can help you easily collect and report events from your mobile app to AWS. This SDK is part of an AWS solution - [Clickstream Analytics on AWS](https://github.com/awslabs/clickstream-analytics-on-aws), which provisions data pipeline to ingest and process event data into AWS services such as S3, Redshift.
5+
Clickstream Flutter SDK can help you easily collect and report events from your mobile app to AWS. This SDK is part of an AWS solution - [Clickstream Analytics on AWS](https://github.com/aws-solutions/clickstream-analytics-on-aws), which provisions data pipeline to ingest and process event data into AWS services such as S3, Redshift.
86

9-
The SDK relies on the [Clickstream Android SDK](https://github.com/awslabs/clickstream-android) and [Clickstream Swift SDK](https://github.com/awslabs/clickstream-swift). Therefore, flutter SDK also supports automatically collect common user events and attributes (e.g., session start, first open). In addition, we've added easy-to-use APIs to simplify data collection in Flutter apps.
7+
The SDK relies on the [Clickstream Android SDK](https://github.com/aws-solutions/clickstream-analytics-on-aws-android-sdk) and [Clickstream Swift SDK](https://github.com/aws-solutions/clickstream-analytics-on-aws-swift-sdk). Therefore, flutter SDK also supports automatically collect common user events and attributes (e.g., session start, first open). In addition, we've added easy-to-use APIs to simplify data collection in Flutter apps.
108

11-
Visit our [Documentation site](https://awslabs.github.io/clickstream-analytics-on-aws/en/latest/sdk-manual/flutter/) to learn more about Clickstream Flutter SDK.
9+
Visit our [Documentation site](https://aws-solutions.github.io/clickstream-analytics-on-aws/en/latest/sdk-manual/flutter/) to learn more about Clickstream Flutter SDK.
1210

1311
## Integrate SDK
1412

@@ -287,3 +285,7 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform
287285
## License
288286

289287
This library is licensed under the [Apache 2.0 License](./LICENSE).
288+
289+
## Anonymous operational metrics
290+
291+
This solution collects anonymous operational metrics to help AWS improve the quality and features of the solution. For more information, including how to disable this capability, please see the [implementation guide](https://docs.aws.amazon.com/solutions/latest/clickstream-analytics-on-aws/solution-overview.html).

‎SECURITY.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Reporting Security Issues
2+
3+
We take all security reports seriously.
4+
When we receive such reports,
5+
we will investigate and subsequently address
6+
any potential vulnerabilities as quickly as possible.
7+
If you discover a potential security issue in this project,
8+
please notify AWS/Amazon Security via our
9+
[vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/)
10+
or directly via email to [AWS Security](mailto:[email protected]).
11+
Please do *not* create a public GitHub issue in this project.

0 commit comments

Comments
 (0)