Skip to content

Commit

Permalink
Merge pull request #297 from ucoProject/Release-0.7.0
Browse files Browse the repository at this point in the history
Release 0.7.0
  • Loading branch information
sbarnum authored Aug 18, 2021
2 parents c0e821d + b337559 commit c83bbca
Show file tree
Hide file tree
Showing 49 changed files with 7,810 additions and 6,585 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# This software was developed at the National Institute of Standards
# and Technology by employees of the Federal Government in the course
# of their official duties. Pursuant to title 17 Section 105 of the
# United States Code this software is not subject to copyright
# protection and is in the public domain. NIST assumes no
# responsibility whatsoever for its use by other parties, and makes
# no guarantees, expressed or implied, about its quality,
# reliability, or any other characteristic.
#
# We would appreciate acknowledgement if the software is used.

# This workflow uses Make to confirm ontology files have been
# normalized.

name: Continuous Integration

on:
push:
branches: [ master, develop ]
pull_request:
branches: [ master, develop ]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v2
with:
distribution: 'adopt'
java-version: '8'
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Start from clean state
run: make clean
- name: Run tests
run: make check
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*.jar
.*.ttl
.git_submodule_init.done.log
.lib.done.log
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "dependencies/CASE-Utility-SHACL-Inheritance-Reviewer"]
path = dependencies/CASE-Utility-SHACL-Inheritance-Reviewer
url = https://github.com/casework/CASE-Utility-SHACL-Inheritance-Reviewer.git
82 changes: 82 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
#!/usr/bin/make -f

# This software was developed at the National Institute of Standards
# and Technology by employees of the Federal Government in the course
# of their official duties. Pursuant to title 17 Section 105 of the
# United States Code this software is not subject to copyright
# protection and is in the public domain. NIST assumes no
# responsibility whatsoever for its use by other parties, and makes
# no guarantees, expressed or implied, about its quality,
# reliability, or any other characteristic.
#
# We would appreciate acknowledgement if the software is used.

SHELL := /bin/bash

turtle_directories := $(shell find uco-* -type d -maxdepth 0 | sort)

all_directories := $(foreach turtle_directory,$(turtle_directories),all-$(turtle_directory))

check_directories := $(foreach turtle_directory,$(turtle_directories),check-$(turtle_directory))

clean_directories := $(foreach turtle_directory,$(turtle_directories),clean-$(turtle_directory))

all: \
$(all_directories)

all-%: \
% \
.lib.done.log
$(MAKE) \
--directory $< \
--file $$PWD/src/review.mk

# This recipe guarantees that 'git submodule init' and 'git submodule update' have run at least once.
# The recipe avoids running 'git submodule update' more than once, in case a user is testing with the submodule at a different commit than what UCO tracks.
.git_submodule_init.done.log: \
.gitmodules
# CASE-Utility-SHACL-Inheritance-Reviewer
test -r dependencies/CASE-Utility-SHACL-Inheritance-Reviewer/README.md \
|| (git submodule init dependencies/CASE-Utility-SHACL-Inheritance-Reviewer && git submodule update dependencies/CASE-Utility-SHACL-Inheritance-Reviewer)
@test -r dependencies/CASE-Utility-SHACL-Inheritance-Reviewer/README.md \
|| (echo "ERROR:Makefile:CASE-Utility-SHACL-Inheritance-Reviewer submodule README.md file not found, even though that submodule is initialized." >&2 ; exit 2)
touch $@

.lib.done.log:
$(MAKE) \
--directory lib
touch $@

check: \
$(check_directories) \
.git_submodule_init.done.log
$(MAKE) \
--directory tests \
check

check-%: \
% \
.lib.done.log
$(MAKE) \
--directory $< \
--file $$PWD/src/review.mk \
check

clean: \
$(clean_directories) \
clean-tests
@rm -f \
.git_submodule_init.done.log \
.lib.done.log

clean-%: \
%
@$(MAKE) \
--directory $< \
--file $$PWD/src/review.mk \
clean

clean-tests:
@$(MAKE) \
--directory tests \
clean
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Through this approach not only are domain-focused representations defined consis
The purpose of this repository is to provide a foundation for broader community involvement in defining what to represent and how.

### Current Release
The current release of UCO is 0.6.0
The current release of UCO is 0.7.0

UCO Version 0.6.0 is primarily focused on adding several community needed classes (URLHistory, refactoring Contact, OnlineService, Profile, etc.) and properties, refactoring and cleaning up Address subclass structure, adding specific subclasses of ObservableObject, renaming of non-observable namespace Facet subclasses to include "Facet" at the end, clarifying and normalizing all class definitions to make the ontology more robust and complete, and cleanup of several minor issues and bugs.
UCO Version 0.7.0 is primarily focused on conversion of UCO ontologies to leverage the Shapes Constraint Language (SHACL) rather than domain assertions and owl property restrictions to define class shapes. In addition, it added a continuous integration (CI) method for testing and verifying the ontology and it corrects several minor issues and bugs.

Future versions of UCO will not only expand and refine the ontology itself but will also provide more complete and formalized documentation.
1 change: 1 addition & 0 deletions dependencies/CASE-Utility-SHACL-Inheritance-Reviewer
46 changes: 46 additions & 0 deletions lib/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
#!/usr/bin/make -f

# This software was developed at the National Institute of Standards
# and Technology by employees of the Federal Government in the course
# of their official duties. Pursuant to title 17 Section 105 of the
# United States Code this software is not subject to copyright
# protection and is in the public domain. NIST assumes no
# responsibility whatsoever for its use by other parties, and makes
# no guarantees, expressed or implied, about its quality,
# reliability, or any other characteristic.
#
# We would appreciate acknowledgement if the software is used.

SHELL := /bin/bash

all: \
rdf-toolkit.jar

# Downloading rdf-toolkit was previously done following the directions
# at:
# https://github.com/edmcouncil/rdf-toolkit
# However, on the file becoming temporarily unavailable, CASE has placed
# a verified copy at a custom location, as a fallback for an alternative
# retrieval from an EDM Council member's repository.
# The checksum of the original file from EDM Council's build server is
# confirmed before moving file into position. (This practice will
# probably require frequent updates, unless a signed checksum for the
# jar can be retrieved somehow.)
# In case there are concerns on potentially multiple writes to the same
# file, the documentation for wget's "--output-document file" flag notes
# that "... file will be truncated immediately, and all downloaded
# content will be written there."
rdf-toolkit.jar:
test -r rdf-toolkit.jar.sha512
# Try retrieval from Github, then from files.caseontology.org.
wget \
--output-document $@_ \
https://github.com/trypuz/openfibo/blob/1f9ab415e8ebd131eadcc9b0fc46241adeeb0384/etc/serialization/rdf-toolkit.jar?raw=true \
|| wget \
--output-document $@_ \
http://files.caseontology.org/rdf-toolkit.jar
test \
"x$$(openssl dgst -sha512 $@_ | awk '{print($$NF)}')" \
== \
"x$$(head -n1 rdf-toolkit.jar.sha512)"
mv $@_ $@
1 change: 1 addition & 0 deletions lib/rdf-toolkit.jar.sha512
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
24890b4aa484a46803841fbe5938daf60bf2d0889c0e231102c033d71cb84a2bfa8b44419df3ad896d833609afddd4b3910d2ce28660b3350cca22bea0770dad
Loading

0 comments on commit c83bbca

Please sign in to comment.