Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development for release 3.1.2 #247

Merged
merged 22 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,22 @@ on:
branches: [ series/3.1.0 ]

jobs:
build:
java8:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Set up Java
uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: 8
cache: maven
- name: Build with Maven
run: mvn -f pom-java8.xml clean install -Dgpg.skip -Dmaven.javadoc.skip=true -Dmaven.test.failure.ignore=true -Dproject.build.sourceEncoding=UTF-8 -Djunit5.excludeGroups=webservice,mysql

build:
needs: java8
runs-on: ubuntu-latest

steps:
Expand Down
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ cff-version: 1.2.0
title: BridgeDb
message: 'If you use this software, please cite it as below.'
type: software
version: 3.1.1
date-released: '2023-12-18'
version: 3.1.2
date-released: '2024-07-30'
authors:
- given-names: Manas
family-names: Awasthi
Expand Down
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Using BridgeDb dependencies
The [BridgeDb releases](https://github.com/bridgedb/BridgeDb/releases) are published to
[Maven Central](http://central.maven.org/maven2/org/bridgedb/), which means you can use the BridgeDb JARs without needing to compile BridgeDb.

Usage depends on which module you require. The examples below assumes artifact `org.bridgedb.bio` and version `3.1.1`:
Usage depends on which module you require. The examples below assumes artifact `org.bridgedb.bio` and version `3.1.2`:

For [Maven](https://maven.apache.org/):

Expand All @@ -24,27 +24,27 @@ For [Maven](https://maven.apache.org/):
<dependency>
<groupId>org.bridgedb</groupId>
<artifactId>org.bridgedb.bio</artifactId>
<version>3.1.1</version>
<version>3.1.2</version>
</dependency>
</dependencies>
```

For [Gradle](https://gradle.org/):

```gradle
compile group: 'org.bridgedb', name: 'org.bridgedb.bio', version: '3.1.1'
compile group: 'org.bridgedb', name: 'org.bridgedb.bio', version: '3.1.2'
```

For [Ivy](http://ant.apache.org/ivy/):

```xml
<dependency org="org.bridgedb" name="org.bridgedb.bio" rev="3.1.1"/>
<dependency org="org.bridgedb" name="org.bridgedb.bio" rev="3.1.2"/>
```

For [Buildr](https://buildr.apache.org/):

```buildr
'org.bridgedb:org.bridgedb.bio:jar:3.1.1'
'org.bridgedb:org.bridgedb.bio:jar:3.1.2'
```


Expand All @@ -58,6 +58,8 @@ able to compile with a simple:
mvn clean install -Dgpg.skip
```

When compiling the Java8-compatible components, use the `pom-java8.xml` file instead, with `mvn -f pom-java8.xml`.

You can find the libraries in the folder called "target", in each sublibrary folder (used to be called "dist" in ant).

If you want to ignore failing tests, e.g. because you are not online,
Expand Down Expand Up @@ -127,13 +129,13 @@ Making releases
---------------

If it is time for a release, first, update `org.bridgedb/src/main/resources/version.props` (for BridgeDb),
this `README.md` and `CITATION.cff` (for Zenodo).
this `README.md` and `CITATION.cff` (for Zenodo), as well as the `pom-java8.xml`.

To make the release, run the following commands. Mind you, this requires you
to have an approved Sonatype (http://oss.sonatype.org/) account with push rights:

```shell
mvn versions:set -DnewVersion=3.1.2-SNAPSHOT
mvn versions:set -DnewVersion=3.1.2
mvn clean deploy
```

Expand All @@ -143,7 +145,7 @@ and everything.
To make a development (SNAPSHOT) release, use:

```shell
mvn versions:set -DnewVersion=3.1.1-SNAPSHOT
mvn versions:set -DnewVersion=3.1.3-SNAPSHOT
mvn clean deploy
```

Expand Down
22 changes: 18 additions & 4 deletions UPGRADE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,49 @@
Upgrade notes to BridgeDb 2.0
# Upgrade notes to BridgeDb 2.0

1. Initialing data sources
## 1. Initialing data sources

Replace

```java
BioDataSource.init();
```

with

```java
DataSourceTxt.init();
```

2. Getting DataSource's
## 2. Getting DataSource's

Replace

```java
DataSource ds = DataSource.getBySystemCode("Ck");
```

with

```java
DataSource ds = DataSource.getExistingBySystemCode("Ck");
```

Similarly, and more important:

```java
DataSource ds = DataSource.getByFullName("PubChem-compound");
```

with

```java
DataSource ds = DataSource.getExistingByFullName("PubChem-compound");
```

The latter two new methods throw an IllegalArgumentException if the DataSource does not exist.
The latter two new methods throw an `IllegalArgumentException` if the `DataSource` does not exist.
Use one of the following two methods to check first:

```java
DataSource.systemCodeExists("Ck");
DataSource.fullNameExists("PubChem-compound");
```
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,7 @@
%{$GeneTables{CCDS}} = ('NAME' => ['CCDS', 'Cc'],
'SYSTEM' => ["\'Consensus CDS Protein Set (NCBI)\'", "\'$dateArg\'",
"\'ID\|\'", "\'\|$species\|\'", "\'\'",
"\'http://www.ncbi.nlm.nih.gov/CCDS/CcdsBrowse.cgi?REQUEST=ALLFIELDS&DATA=~&ORGANISM=".$genus_species."\'", "\'\'",
"\'https://www.ncbi.nlm.nih.gov/CCDS/CcdsBrowse.cgi?REQUEST=ALLFIELDS&DATA=~&ORGANISM=".$genus_species."\'", "\'\'",
"\'ftp://ftp.ncbi.nlm.nih.gov/pub/CCDS/\'"],
'HEADER' => ['ID VARCHAR(128) NOT NULL DEFAULT \'\'',
'PRIMARY KEY (ID)'
Expand Down Expand Up @@ -863,7 +863,7 @@
%{$GeneTables{RGD}} = ('NAME' => ['RGD', 'R'],
'SYSTEM' => ["\'Rat Genome Database\'", "\'$dateArg\'",
"\'ID|Symbol\\\\sBF|Description\\\\BF|Synonyms\\\\BF\|\'", "\'\|$species\|\'", "\'\'",
"\'http://rgd.mcw.edu/query/query.cgi?id=~\'", "\'\'",
"\'https://rgd.mcw.edu/query/query.cgi?id=~\'", "\'\'",
"\'ftp://rgd.mcw.edu/pub/\'"],
'HEADER' => ['ID VARCHAR(128) NOT NULL DEFAULT \'\'',
'Symbol VARCHAR(128) NOT NULL DEFAULT \'\'',
Expand Down Expand Up @@ -916,8 +916,8 @@
%{$GeneTables{GrameneGenes}} = ('NAME' => ['GrameneGenes', 'Gg'],
'SYSTEM' => ["\'Gramene Genes Database\'", "\'$dateArg\'",
"\'ID|Symbol\\\\sBF|Description\\\\BF\|\'", "\'\|$species\|\'", "\'\'",
"\'http://www.gramene.org/db/genes/search_gene?acc=~\'", "\'\'",
"\'http://www.gramene.org\'"],
"\'https://www.gramene.org/db/genes/search_gene?acc=~\'", "\'\'",
"\'https://www.gramene.org\'"],
'HEADER' => ['ID VARCHAR(128) NOT NULL DEFAULT \'\'',
'Symbol VARCHAR(128) NOT NULL DEFAULT \'\'',
'Description VARCHAR(255) DEFAULT NULL',
Expand All @@ -926,8 +926,8 @@
%{$GeneTables{GramenePathway}} = ('NAME' => ['GramenePathway', 'Gm'],
'SYSTEM' => ["\'Gramene Pathway\'", "\'$dateArg\'",
"\'ID|Description\\\\BF\|\'", "\'\|$species\|\'", "\'\'",
"\'http://www.gramene.org/pathway\'", "\'\'",
"\'http://www.gramene.org/pathway\'"],
"\'https://www.gramene.org/pathway\'", "\'\'",
"\'https://www.gramene.org/pathway\'"],
'HEADER' => ['ID VARCHAR(128) NOT NULL DEFAULT \'\'',
'Description VARCHAR(255) DEFAULT NULL',
'PRIMARY KEY (ID)'
Expand Down
2 changes: 1 addition & 1 deletion examples/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<parent>
<artifactId>bridgedb-bundle</artifactId>
<groupId>org.bridgedb</groupId>
<version>3.1.1</version>
<version>3.1.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>org.bridgedb.examples</groupId>
Expand Down
2 changes: 1 addition & 1 deletion org.bridgedb.bio/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<parent>
<artifactId>bridgedb-bundle</artifactId>
<groupId>org.bridgedb</groupId>
<version>3.1.1</version>
<version>3.1.2</version>
</parent>

<build>
Expand Down
Loading
Loading