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

beacon file script #397

Open
wants to merge 2 commits into
base: dspace-cris-2023_02_x
Choose a base branch
from

Conversation

floriangantner
Copy link

@floriangantner floriangantner commented Oct 26, 2023

References

Add references/links to any related issues or PRs. These may include:

  • Fixes #issue-number (if this fixes an issue ticket)

Description

Working state of our Script to generate beacon files of some identifier based on the beacon draft (https://gbv.github.io/beaconspec/beacon.html) (our implementation in dspace 5 was mentioned in some earlier PR #218)
Script for generating files according to the beacon standard (see https://gbv.github.io/beaconspec/beacon.html). It get all (visibile) entities of some identifier and prints them into one process result file or optionally dumps them in the handler log. The usage is mainly popular among GLAM-Systems using the gnd-identifier in the DACH-Area. The header lines can be configured in the configuration.

Instructions for Reviewers

This is mainly some working solution for institutions in the DACH-Area (Germany, Austria, Switzerland) , e.g. archives or libraries to generate beacon files with gnd-identifiers. Feel free to pick it up and modify to your needs.

List of changes in this PR:

  • introduced new beacon script.
  • It works over the whole site on discoverable entities.
  • Identifier, main resolver and additional resolvers as well as the header lines can be configured in beacon.cfg

Include guidance for how to test or review your PR. This may include: steps to reproduce a bug, screenshots or description of a new feature, or reasons behind specific changes.

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You need not complete this checklist prior to creating your PR (draft PRs are always welcome). If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & integration tests). Exceptions may be made if previously agreed upon.
  • My PR passes Checkstyle validation based on the Code Style Guide.
  • My PR includes Javadoc for all new (or modified) public methods and classes. It also includes Javadoc for large or complex private methods.
  • My PR passes all tests and includes new/updated Unit or Integration Tests based on the Code Testing Guide.
  • If my PR includes new libraries/dependencies (in any pom.xml), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR modifies REST API endpoints, I've opened a separate REST Contract PR related to this change.
  • If my PR includes new configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

script for generating files according to the beacon standard (see https://gbv.github.io/beaconspec/beacon.html). It get all (visibile) entities of some identifier and prints them into one process result file or optionally dumps them in the handler log. The usage is mainly popular among GLAM-Systems using the gnd-identifier in the DACH-Area. The header lines can be configured in the configuration.
[maven-release-plugin] copy for tag dspace-cris-2023.02.02
@floriangantner floriangantner changed the base branch from dspace-cris-7 to main-cris February 20, 2024 15:00
@floriangantner
Copy link
Author

aligned to 2023.02.02 Release

@floriangantner floriangantner changed the base branch from main-cris to dspace-cris-2023_02_x April 9, 2024 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants