Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nasa-pds/registry-mgr

Standalone Registry Manager application responsible for managing the PDS Registry (https://github.com/NASA-PDS/registry) schemas and indexes.
https://github.com/nasa-pds/registry-mgr

elasticsearch nasa nasa-pds

Last synced: 17 days ago
JSON representation

Standalone Registry Manager application responsible for managing the PDS Registry (https://github.com/NASA-PDS/registry) schemas and indexes.

Awesome Lists containing this project

README

        

# PDS Registry Manager Elastic

[![🤪 Unstable integration & delivery](https://github.com/NASA-PDS/registry-mgr/actions/workflows/unstable-cicd.yaml/badge.svg)](https://github.com/NASA-PDS/registry-mgr/actions/workflows/unstable-cicd.yaml) [![😌 Stable integration & delivery](https://github.com/NASA-PDS/registry-mgr/actions/workflows/stable-cicd.yaml/badge.svg)](https://github.com/NASA-PDS/registry-mgr/actions/workflows/stable-cicd.yaml)

The [Planetary Data System](https://pds.nasa.gov/) Registry Manager provides functionality for configuring the PDS Registry Elastic. It's a sub-component of the PDS Registry Service (https://github.com/NASA-PDS/registry).

## Documentation

The documentation for the latest release of the PDS Registry (of which this software is a component)—including release notes, installation, and operation—is online at https://nasa-pds.github.io/registry/.

## Build

The software can be compiled and built with the `mvn compile` command but in order to create the JAR file, you must execute the `mvn compile jar:jar` command.

In order to create a complete distribution package, execute the following commands:
```
% mvn site
% mvn package
```

## Release

Thanks to [GitHub Actions](https://github.com/features/actions) and the [Roundup Action](https://github.com/NASA-PDS/roundup-action), this software is automatically released to the Maven Central Repository.

But if you need to do this manually, the procedure is described below.

### Pre-Requisites

- Make sure you have your GPG Key created and sent to server.
- Make sure you have your `.settings` configured correctly for GPG:
```xml



true


gpg
KEY_NAME
KEY_PASSPHRASE

```

### Operational Release

1. Checkout the dev branch.
2. Version the software:
```console
$ mvn versions:set -DnewVersion=1.2.0
```

3. Deploy software to Sonatype Maven repo:
```console
$ # Operational release
$ mvn clean site deploy -P release
```

4. Create pull request from dev → main and merge.
5. Tag release in Github
6. Update version to next snapshot:
```console
$ mvn versions:set -DnewVersion=1.3.0-SNAPSHOT
```

### Snapshot Release

1. Checkout the dev branch.
2. Deploy software to Sonatype Maven repo:
```console
$ # Operational release
$ mvn clean site deploy
```

## Maven JAR Dependency Reference

This setion describes the Java jar dependencies.

### Official Releases

https://search.maven.org/search?q=g:gov.nasa.pds%20AND%20a:registry&core=gav

### Snapshots

https://oss.sonatype.org/content/repositories/snapshots/gov/nasa/pds/registry/

👉 **Note:** the above link may be broken.

If you want to access snapshots, add the following to your `~/.m2/settings.xml`:
```xml


allow-snapshots
true


snapshots-repo
https://oss.sonatype.org/content/repositories/snapshots
false
true


```

## 📃 License

The project is licensed under the [Apache version 2](LICENSE.md) license.