Skip to content

Commit

Permalink
Github release
Browse files Browse the repository at this point in the history
  • Loading branch information
TasDeniz committed Nov 27, 2020
1 parent c819dfc commit 7af0f88
Show file tree
Hide file tree
Showing 701 changed files with 31,397 additions and 47,896 deletions.
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ jobs:
- run: mvn -B install -Psamply

- setup_remote_docker
- run: docker build -t martinbreu/samply-connector:latest .
- run: docker build -t martinbreu/samply-connector:${CIRCLE_SHA1} .
- run: docker login -u martinbreu -p "${DOCKER_HUB_PASSWD}"
- run: docker push martinbreu/samply-connector:latest
- run: docker push martinbreu/samply-connector:${CIRCLE_SHA1}
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
**Describe your problem.**

A clear and concise description of what the problem is.


**If it is a bug name steps to reproduce**

Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error


**If it is a bug complete the following information:**

- Version: [e.g. 1.2.3]
- OS: [e.g. Windows, Linux, OS X]
- Browser: [e.g. chrome, firefox, safari]


**Describe the solution you'd like**

A clear and concise description of what you want to happen.


**Additional context**

Add any other context or screenshots about the feature request here.
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
**What's in the PR**
* ...

**How to test manually**
* ...
32 changes: 32 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven

name: Java CI with Maven

on: [ push, pull_request ]

jobs:
build:

runs-on: ubuntu-latest
services:
postgres:
image: postgres
env:
POSTGRES_DB: samply.connector
POSTGRES_PASSWORD: samply
POSTGRES_USER: samply
POSTGRES_HOST: localhost
ports:
- 5432:5432

steps:
- uses: actions/checkout@v2

- name: Setup Java
uses: actions/setup-java@v1
with:
java-version: 8

- name: Build with Maven
run: mvn -B package -P samply
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [7.0.0 - 2020-11-27]
- Github release
### Changed
- Samply parent 11.1.0
## Added
- Github Actions
- Google Code Style
### Bugfix
- fixed functional tests for BLAZE

## [6.13.0 - 2020-10-14]
### Changed
- changed locale default from de to en
Expand Down
95 changes: 95 additions & 0 deletions GETTINGSTARTED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# Getting started

## Cloning the repository

Choose or create a directory for the repository to get cloned into, such as your Desktop. This is the directory we'll be working out of, so pick somewhere convenient.

Using a CLI, run the following command in the directory: `git clone https://github.com/samply/share-client.git`

Once the command has finished executing, you should have a copy of this repository named `share-client` inside your project directory.

## Setting up the environment

### Requirements

You will need [Intelj IDEA](https://www.jetbrains.com/idea/) (the community edition is freely available for download) and [Java SDK](https://www.oracle.com/java/technologies/javase-downloads.html) to build the project, aswell as [Maven](https://maven.apache.org/).

## Working in this repository

From now on, whenever you want to make a change in the repository, you will first need to branch off the master branch. Using a CLI in the `share-client` directory, first check if the master branch is fully up to date:

```
git checkout master
git fetch
git pull
```

Now you can create a new branch. Please use the `feature-` prefix so that it's clear that your branch is a temporary, in-progress development branch. Creating your branch can be done using one of two methods:

### CLI

Simply enter `git checkout -b feature-somenamehere` to have a branch created for you.

### GitHub for Desktop

In the application, go to ``Branch -> New branch...``. Give this an appropriate name (don't forget the prefix) and ensure that the branch is based on the `master` branch.


### Test your changes
After you are done with your changes, you need to test it locally before you create a new pull request.
This can be done using [Tomcat](#tomcat) or [Docker](#docker).

#### Tomcat
If you do not have [Tomcat](http://tomcat.apache.org/) please install the newest version of it.
Then do the following steps:
* Add Tomcat to the "Run/Debug Configurations" of Intellij
* In the "Server" tab you can choose the port of Tomcat (default 8080)
* Go to the "Deployment" tab and add the "share-client:war" artifact

#### Postgres
You also need [Postgres](https://www.postgresql.org/download/) for the manual version of deploying.
The connector uses jooq and flyway to create the database.

Depends on which maven profile you use, the configuration for the postgres can change.
In the [pom.xml](https://github.com/samply/share-client/blob/master/pom.xml) you can see the configurations for each profile.
Please create the user and the database in postgres according to the selected profile.
After you created the database run in Intellij the command `mvn flyway:clean flyway:migrate jooq-codegen:generate` to initialise the empty database.

After the configuration of Tomcat and Postgres run the maven command `mvn clean install` and run Tomcat in Intellij to deploy and run the connector with your changes.

#### Docker (Only works with Maven profile "samply")
If you want to use [Docker](https://www.docker.com/) for testing your changes you can do it by running the following commands.
* `mvn clean install` to create a WAR-file for the Docker image
* Run at the directory of the share-client project the following script to deploy a Postgres container and then a connector container:


docker rm pg-connector

docker run \
--name pg-connector \
-e POSTGRES_USER=samply \
-e POSTGRES_DB=samply.connector \
-e POSTGRES_PASSWORD=samply \
-p 5432:5432 \
postgres:9.6

docker rm connector

docker build . -t connector:latest

docker run \
--name=connector \
-p 8082:8080 \
-e POSTGRES_HOST='pg-connector' \
-e POSTGRES_DB='samply.connector' \
-e POSTGRES_USER='samply' \
-e POSTGRES_PASS='samply' \
-e MDR_URL='https://mdr.germanbiobanknode.de/v3/api/mdr' \
-e STORE_URL='http://store:8080' \
-e QUERY_LANGUAGE='CQL' \
-e CATALINA_OPTS='"-Xmx2g"' \
connector

### Pull Request
After you tested your changes you can create on Github a new pull request. Please merge new feature branches only into develop.
201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2020 The Samply Development Community

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading

0 comments on commit 7af0f88

Please sign in to comment.