Skip to content

Commit fdf683c

Browse files
mbroechelervelo
mbroecheler
and
velo
authored
Release Prep (#3)
* update documentation * Format sources Signed-off-by: Marvin Froeder <marvin@datasqrl.com> * Create unit test that runs CreditcardRewards example Signed-off-by: Marvin Froeder <marvin@datasqrl.com> * Add SPRING_AI_OPENAI_API_KEY to env vars Signed-off-by: Marvin Froeder <marvin@datasqrl.com> * Move sqrl-creditcard-rewards example to new module Signed-off-by: Marvin Froeder <marvin@datasqrl.com> * Added rick and morty example Signed-off-by: Marvin Froeder <marvin@datasqrl.com> * Reduce amount of duplicate configuration Signed-off-by: Marvin Froeder <marvin@datasqrl.com> * Move config.backend-url to application.properties * Simplify configuration Signed-off-by: Marvin Froeder <marvin@datasqrl.com> * Fix query generation with nestedFields Signed-off-by: Marvin Froeder <marvin@datasqrl.com> * Added README for rick morty example * [nitpick] The method name 'getGetMessageContextKeys' is redundant Signed-off-by: Marvin Froeder <marvin@datasqrl.com> * Adding jacoco hoops for aggregated code coverage Signed-off-by: Marvin Froeder <marvin@datasqrl.com> --------- Signed-off-by: Marvin Froeder <marvin@datasqrl.com> Co-authored-by: Marvin Froeder <marvin@datasqrl.com>
1 parent 4e16152 commit fdf683c

File tree

66 files changed

+2083
-322
lines changed

Some content is hidden

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

66 files changed

+2083
-322
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
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+
1.
16+
2.
17+
3.
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Environment**
23+
24+
- Node.js version:
25+
- acorn.js version:
26+
- OS:
27+
28+
**Additional context**
29+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
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 solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Description
2+
3+
<!--- Describe your changes in detail -->
4+
5+
## Related Issue
6+
7+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
8+
<!--- Please link to the issue here: -->
9+
10+
## Types of changes
11+
12+
<!--- What types of changes does your code introduce? Put an `x` in all boxes that apply: -->
13+
14+
- [ ] Bug fix (non-breaking change which fixes an issue)
15+
- [ ] New feature (non-breaking change which adds functionality)
16+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
17+
18+
## Checklist
19+
20+
<!--- Go over all the following points, and put an `x` in all boxes that apply. -->
21+
22+
- [ ] My code follows the code style of this project
23+
- [ ] My change requires a documentation update
24+
- [ ] I have updated the documentation accordingly
25+
- [ ] I have added tests to cover my changes
26+
- [ ] All new and existing tests passed

‎.github/workflows/maven.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ jobs:
2626
./mvnw -B org.apache.maven.plugins:maven-dependency-plugin:3.8.1:go-offline de.qaware.maven:go-offline-maven-plugin:1.2.8:resolve-dependencies
2727
2828
- name: Build with Maven
29+
env:
30+
SPRING_AI_OPENAI_API_KEY: ${{ secrets.SPRING_AI_OPENAI_API_KEY }}
2931
run: ./mvnw -B test -Pci
3032

3133
- name: Import GPG Key

‎CONTRIBUTING.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
## Contributing to Acorn
2+
3+
Thanks for your interest in DataSQRL's Acorn.
4+
5+
# Contributions
6+
7+
We welcome contributions from anyone.
8+
9+
Submit a pull request and it will be reviewed by a contributor or committer in the project. The
10+
contributor may ask for changes or information before being accepted.
11+
12+
## Committers
13+
14+
Committers for this project can be viewed on the Github project page.
15+
16+
# Sign Your Work
17+
18+
The _sign-off_ is a simple line at the end of the message for a commit. All commits need to be signed.
19+
Your signature certifies that you wrote the patch or otherwise have the right to contribute the material
20+
(see [Developer Certificate of Origin](https://developercertificate.org)):
21+
22+
```
23+
This is my commit message
24+
25+
Signed-off-by: John Doe <john.doe@example.com>
26+
```
27+
28+
Git has a [`-s`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) command line option to
29+
append this automatically to your commit message:
30+
31+
```bash
32+
$ git commit -s -m "This is my commit message"
33+
```
34+
35+
Unfortunately, anyone with write access to a repository can easily impersonate another user.
36+
Consider how each commit is associated with a user via their email address.
37+
There's nothing stopping someone from using someone else's email address to make commits.
38+
The issue extends to the signoff message as well.
39+
40+
That's why it's advisable to sign your commits with a unique key. Git offers support for various types of keys,
41+
and this time, we'll walk you through signing your commits using GPG.
42+
43+
#### Setup Git using GPG
44+
45+
Ensure that gpg is installed on your system.
46+
47+
On MacOS:
48+
49+
```bash
50+
brew install gpg
51+
```
52+
53+
Generate your key:
54+
55+
```bash
56+
gpg --full-generate-key
57+
```
58+
59+
Recommended settings:
60+
61+
- **key kind:** (1) RSA and RSA
62+
- **key size:** 4096
63+
- **key validity:** key does not expire
64+
(you can revoke keys, so unless you don't lose access to your key it is more convenient)
65+
- **real name:** it is recommended using your real name
66+
- **email address:** it is recommended to use the same email address here that you use to commit your work
67+
- **comment:** it is recommended to use different keys for different use-cases / organizations.
68+
If you use the same email across organizations, you can distinguish your keys with the help of this field.
69+
eg.: "CODE SIGNING KEY" or "ACORN CODE SIGNING KEY"
70+
71+
You can create the new key by selecting "(O)kay"
72+
73+
To view your key, you issue this command:
74+
75+
```bash
76+
gpg --list-secret-keys --keyid-format=long
77+
```
78+
79+
The output should look like this:
80+
81+
```
82+
sec rsa4096/D2A162EAE1016F3G 2024-04-05 [SC]
83+
AFB8C2DEFEA93470D81C84E7D2A162EAE1016F3G
84+
uid [ultimate] John Doe (CODE SIGNING KEY) <john.doe@example.com>
85+
ssb rsa4096/2F7B9EAC4D6F8150 2024-04-05 [E]
86+
```
87+
88+
To use the above key to sign your commits cd into a repository and issue these commands:
89+
90+
```bash
91+
git config user.signingkey D2A162EAE1016F3G
92+
git config commit.gpgsign true
93+
```
94+
95+
You also need to add the public key to your github profile for the signing to be verified.
96+
97+
To do so, go to your github settings page, select the `SSH and GPG keys` tab.
98+
99+
Press `New GPG Key`, then enter a name for the key and the outputs of the following command.
100+
101+
```
102+
gpg --armor --export D2A162EAE1016F3G
103+
```
104+
105+
## License
106+
107+
By contributing to Acorn, you agree that your contributions will be licensed under the Apache License 2.0.

‎Dockerfile‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)