Skip to content

Commit b7eeaea

Browse files
authored
Changes for v0.12.3 (#67)
1 parent cb31dd2 commit b7eeaea

Some content is hidden

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

78 files changed

+3695
-2874
lines changed

.eslintrc.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@
88
"plugin:@typescript-eslint/recommended",
99
"prettier"
1010
],
11-
"overrides": [],
11+
"overrides": [
12+
{
13+
"files": ["test/**/*"],
14+
"env": {
15+
"jest": true
16+
}
17+
}
18+
],
1219
"parserOptions": {
1320
"ecmaVersion": "latest",
1421
"sourceType": "module"

.github/ISSUE_TEMPLATE/bug_report.yaml

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: Bug Report
2-
description: Create a report to help us improve
2+
about: Create a report to help us improve
3+
title: ''
4+
labels: 'bug'
5+
assignees: ''
36
body:
47
- type: textarea
58
id: description
@@ -90,6 +93,11 @@ body:
9093
- Safari/537.36
9194
validations:
9295
required: true
96+
- type: textarea
97+
id: context
98+
attributes:
99+
label: Screenshots
100+
description: If applicable, add screenshots to help explain your problem (please **DO NOT include sensitive information**).
93101
- type: textarea
94102
id: context
95103
attributes:

.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.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
- type: textarea
1313
id: proposal
1414
attributes:
15-
label: Describe the solution you'd like
15+
label: Describe the feature you'd like
1616
description: A clear and concise description of what you want to happen.
1717
validations:
1818
required: true
+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.

.github/dependabot.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Basic `dependabot.yml` file with
2+
3+
version: 2
4+
updates:
5+
# Enable version updates for github-actions
6+
- package-ecosystem: "github-actions"
7+
directory: "/"
8+
# Check the actions for updates every week
9+
schedule:
10+
interval: "weekly"

.github/release.yml

-11
This file was deleted.

.github/workflows/build.yml

-17
This file was deleted.

.github/workflows/code-lint.yml

-19
This file was deleted.

.github/workflows/release.yml

-47
This file was deleted.

.github/workflows/test.yml

-23
This file was deleted.

.github/workflows/title-lint.yml

-24
This file was deleted.

.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,10 @@ yarn.lock
1919
*.tsbuildinfo
2020
*.tgz
2121
/src/config.ts
22+
.scannerwork/*
23+
deployment/open-source/
24+
deployment/regional-s3-assets
25+
deployment/global-s3-assets
26+
deployment/exclude-open-source-list.txt
2227

2328
build

.prettierrc.js

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
14
module.exports = {
25
trailingComma: 'es5',
36
singleQuote: true,

.viperlightignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Use of opensource-codeofconduct email for amazon is expected
2+
CONTRIBUTING.md
3+
CODE_OF_CONDUCT.md
4+
5+
.github/
6+
node_modules/
7+
coverage/
8+
.*/package-lock.json

CHANGELOG.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
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.12.3] - 2025-02-28
9+
10+
### Added
11+
12+
- Updated GitHub link to https://github.com/aws-solutions/clickstream-analytics-on-aws-web-sdk
13+
- Update gradle and fix vulnerabilities

CONTRIBUTING.md

+7-61
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
1111

1212
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1313

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

1717
* A reproducible test case or series of steps
@@ -21,64 +21,6 @@ reported the issue. Please try to include as much information as you can. Detail
2121

2222

2323
## Contributing via Pull Requests
24-
25-
This is mostly the same as [GitHub's guide on creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
26-
27-
First, create a _fork_ of `clickstream-web`. Clone it, and make changes to this _fork_.
28-
29-
```shell
30-
git clone [email protected]:your_username/clickstream-web.git
31-
```
32-
33-
After you have tested your feature/fix, by adding sufficient test coverage, and
34-
validating Checkstyle, lint, and the existing test suites, you're ready to
35-
publish your change.
36-
37-
The commit message should look like below. It started with a prefix like feat/fix or
38-
chore. After a paragraph describing what you've done, include links to useful resources. These might
39-
include design documents, StackOverflow implementation notes, GitHub issues,
40-
etc. All links must be publicly accessible.
41-
42-
```console
43-
feat: add new preset event for screen view.
44-
45-
Resolves: https://github.com/awslabs/clickstream-web/issues/222
46-
See also: https://stackoverflow.com/a/58662077/695787
47-
```
48-
49-
Now, save your work to a new branch:
50-
51-
```shell
52-
git checkout -b feature_page_view
53-
```
54-
55-
To publish it:
56-
57-
```shell
58-
git push -u origin feature_page_view
59-
```
60-
61-
This last step will give you a URL to view a GitHub page in your browser.
62-
Copy-paste this, and complete the workflow in the UI. It will invite you to
63-
"create a PR" from your newly published branch.
64-
65-
### Pull Request Guidelines
66-
- The title of your PR must be descriptive to the specific change.
67-
- The title of your PR must be of below format since next release version is determined from PR titles in the commit history.
68-
- For a bugfix: `fix: description of changes`
69-
- For a feature: `feat: add awesome feature`
70-
- Everything else: `chore: fix build script`
71-
- No period at the end of the title.
72-
- Pull Request message should indicate which issues are fixed: `fixes #<issue>` or `closes #<issue>`.
73-
- If not obvious (i.e. from unit tests), describe how you verified that your change works.
74-
- If this PR includes breaking changes, they must be listed at the top of the changelog as described above in the Pull Request Checklist.
75-
- PR must be reviewed by at least one repository maintainer, in order
76-
to be considered for inclusion.
77-
- PR must also pass the Actions like Checkstyle, Lint, and Unit tests.
78-
- Usually all these are going to be **squashed** when you merge to main.
79-
- Make sure to update the PR title/description if things change.
80-
- Rebase with the `main` branch if it has commits ahead of your fork.
81-
8224
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
8325

8426
1. You are working against the latest source on the *main* branch.
@@ -99,7 +41,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
9941

10042

10143
## Finding contributions to work on
102-
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.
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'](https://github.com/aws-solutions/clickstream-analytics-on-aws-web-sdk/labels/help%20wanted) issues is a great place to start.
10345

10446

10547
## Code of Conduct
@@ -114,4 +56,8 @@ If you discover a potential security issue in this project we ask that you notif
11456

11557
## Licensing
11658

117-
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
59+
See the [LICENSE](https://github.com/aws-solutions/%%SOLUTION_NAME%%/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
60+
61+
We may ask you to sign a [Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
62+
63+

0 commit comments

Comments
 (0)