Skip to content

Commit 64c5403

Browse files
committed
Merge branch 'dev' into sync
2 parents 6d5fb89 + 9d840d8 commit 64c5403

File tree

6 files changed

+106
-33
lines changed

6 files changed

+106
-33
lines changed

.github/ISSUE_TEMPLATE.md

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

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
:rotating_light: First, please check:
11+
- existing issues,
12+
- Docs https://docs.objectbox.io/
13+
- Troubleshooting page https://docs.objectbox.io/troubleshooting
14+
- FAQ page https://docs.objectbox.io/faq
15+
16+
**Describe the bug**
17+
A clear and concise description in English of what the bug is.
18+
19+
**Basic info (please complete the following information):**
20+
- ObjectBox version (are you using the latest version?): [e.g. 2.7.0]
21+
- Reproducibility: [e.g. occurred once only | occasionally without visible pattern | always]
22+
- Device: [e.g. Galaxy S20]
23+
- OS: [e.g. Android 10]
24+
25+
**To Reproduce**
26+
Steps to reproduce the behavior:
27+
1. Put '...'
28+
2. Make changes to '....'
29+
3. See error
30+
31+
**Expected behavior**
32+
A clear and concise description of what you expected to happen.
33+
34+
**Code**
35+
If applicable, add code to help explain your problem.
36+
- Include affected entity classes.
37+
- Please remove any unnecessary or confidential parts.
38+
- At best, link to or attach a project with a failing test.
39+
40+
**Logs, stack traces**
41+
If applicable, add relevant logs, or a stack trace.
42+
- For __build issues__, use `--stacktrace` for the Gradle build (`./gradlew build --stacktrace`).
43+
- For __runtime errors__, check Android's Logcat (also check logs before the issue!).
44+
45+
**Additional context**
46+
Add any other context about the problem here.
47+
- Is there anything special about your app?
48+
- May transactions or multi-threading play a role?
49+
- Did you find any workarounds to prevent the issue?

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question
4+
url: https://stackoverflow.com/questions/tagged/objectbox
5+
about: Ask how to do something, or why it isn't working on Stack Overflow.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea
4+
title: ''
5+
labels: 'feature'
6+
assignees: ''
7+
8+
---
9+
10+
:rotating_light: First, please check:
11+
- existing issues,
12+
- Docs https://docs.objectbox.io/
13+
- Troubleshooting page https://docs.objectbox.io/troubleshooting
14+
- FAQ page https://docs.objectbox.io/faq
15+
16+
Start with a clear and concise description of what problem you are trying to solve.
17+
Often there is already a solution!
18+
19+
**Describe the solution you'd like**
20+
A clear and concise description of what you want to happen.
21+
22+
**Describe alternatives you've considered**
23+
A clear and concise description of any alternative solutions or features you've considered.
24+
25+
**Additional context**
26+
Add any other context (e.g. platform or language) about the feature request here.

objectbox-java/build.gradle

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ apply plugin: "com.github.spotbugs"
44
sourceCompatibility = JavaVersion.VERSION_1_8
55
targetCompatibility = JavaVersion.VERSION_1_8
66

7+
ext {
8+
javadocForWebDir = "$buildDir/docs/web-api-docs"
9+
}
10+
711
dependencies {
812
api project(':objectbox-java-api')
913
implementation 'org.greenrobot:essentials:3.0.0-RC1'
@@ -56,9 +60,10 @@ task javadocForWeb(type: Javadoc) {
5660
source = filteredSources + srcApi
5761

5862
classpath = sourceSets.main.output + sourceSets.main.compileClasspath
59-
destinationDir = reporting.file("web-api-docs")
63+
destinationDir = file(javadocForWebDir)
6064

6165
title = "ObjectBox Java ${version} API"
66+
options.overview = "$projectDir/src/web/overview.html"
6267
options.bottom = 'Available under the Apache License, Version 2.0 - <i>Copyright &#169; 2017-2020 <a href="http://objectbox.io/">ObjectBox Ltd</a>. All Rights Reserved.</i>'
6368

6469
doLast {
@@ -86,6 +91,8 @@ task javadocForWeb(type: Javadoc) {
8691
" color:#474747;\n" +
8792
" overflow:auto;\n" +
8893
"}")
94+
95+
println "Javadoc for web created at $destinationDir"
8996
}
9097
}
9198

@@ -96,7 +103,7 @@ task packageJavadocForWeb(type: Zip, dependsOn: javadocForWeb) {
96103
archiveFileName = "objectbox-java-web-api-docs.zip"
97104
destinationDirectory = file("$buildDir/dist")
98105

99-
from reporting.file("web-api-docs")
106+
from file(javadocForWebDir)
100107

101108
doLast {
102109
println "Javadoc for web packaged to ${file("$buildDir/dist/objectbox-java-web-api-docs.zip")}"

objectbox-java/src/web/overview.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<HTML>
2+
<BODY>
3+
<p>
4+
Welcome to the JavaDocs for <a href="https://objectbox.io">ObjectBox</a>, the super-fast database for objects.
5+
On these pages, you will find the API reference for the ObjectBox Java library.
6+
</p>
7+
<p>
8+
The <b>main documentation</b> is available at <a href="https://docs.objectbox.io">docs.objectbox.io</a> and offers
9+
a changelog, a <a href="https://docs.objectbox.io/getting-started">getting started guide</a>, and many more topics.
10+
</p>
11+
<p>
12+
GitHub links: <a href="https://github.com/objectbox/objectbox-java">ObjectBox Java</a>,
13+
<a href="https://github.com/objectbox/objectbox-examples">Examples for Java, Kotlin and Android</a>
14+
</p>
15+
16+
</BODY>
17+
</HTML>

0 commit comments

Comments
 (0)