Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nasa-pds/transform
Transforms PDS3 and PDS4 product labels and data into various formats.
https://github.com/nasa-pds/transform
pds3 pds4 transformations
Last synced: 4 days ago
JSON representation
Transforms PDS3 and PDS4 product labels and data into various formats.
- Host: GitHub
- URL: https://github.com/nasa-pds/transform
- Owner: NASA-PDS
- License: apache-2.0
- Created: 2019-07-23T22:25:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T19:45:00.000Z (3 months ago)
- Last Synced: 2024-08-01T22:04:39.156Z (3 months ago)
- Topics: pds3, pds4, transformations
- Language: Java
- Homepage: https://nasa-pds.github.io/transform/
- Size: 48.8 MB
- Stars: 14
- Watchers: 11
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Transform Tool
[](https://doi.org/10.5281/zenodo.5756418) [](https://github.com/NASA-PDS/transform/actions/workflows/unstable-cicd.yaml) [](https://github.com/NASA-PDS/transform/actions/workflows/stable-cicd.yaml)
Project containing software for transforming PDS3 and PDS4 labels and data products into various formats.
# Documentation
The documentation for the latest release of the Transform Tool, including release notes, installation and operation of the software are online at https://nasa-pds.github.io/transform/.
If you would like to get the latest documentation, including any updates since the last release, you can execute the "mvn site:run" command and view the documentation locally at http://localhost:8080.
# 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
```
# Operational Release
A release candidate should be created after the community has determined that a release should occur. These steps should be followed when generating a release candidate and when completing the release.
## Clone fresh repo
```
git clone [email protected]:NASA-PDS/transform.git
```
## Update Version Numbers
Update pom.xml for the release version or use the Maven Versions Plugin, e.g.:
```
# Skip this step if this is a RELEASE CANDIDATE, we will deploy as SNAPSHOT version for testing
VERSION=1.10.0
mvn versions:set -DnewVersion=$VERSION
git add pom.xml
```
## Update Changelog
Update Changelog using [Github Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator). Note: Make sure you set `$CHANGELOG_GITHUB_TOKEN` in your `.bash_profile` or use the `--token` flag.
```
# For RELEASE CANDIDATE, set VERSION to future release version.
github_changelog_generator --future-release v$VERSION
# Only git add for OPERATIONAL release, but will be used later on for Github Release
git add CHANGELOG.md
```
## Commit Changes
Commit changes using following template commit message:
```
# For operational release
git commit -m "[RELEASE] Validate v$VERSION"
# For release candidate
CANDIDATE_NUM=1
git commit -m "[RELEASE] Validate v${VERSION}-rc${CANDIDATE_NUM}"
# Push changes to main
git push -u origin main
```
## Build and Deploy Software to [Sonatype Maven Repo](https://repo.maven.apache.org/maven2/gov/nasa/pds/).
```
# For operational release
mvn clean site deploy -P release
# For release candidate
mvn clean site deploy
```
Note: If you have issues with GPG, be sure to make sure you've created your GPG key, sent to server, and have the following in your `~/.m2/settings.xml`:
```
true
gpg
KEY_NAME
KEY_PASSPHRASE
```
## Push Tagged Release
```
# For operational release
git tag v${VERSION}
git push --tags
# For RELEASE CANDIDATE
git tag v${VERSION}-SNAPSHOT
git push --tags
```
## Deploy Site to Github Pages
From cloned repo:
```
git checkout gh-pages
# Create specific version site
mkdir -p $VERSION
# Copy the over to version-specific and default sites
rsync -av target/site/ $VERSION
rsync -av $VERSION/* .
git add .
# For operational release
git commit -m "Deploy v$VERSION docs"
# For release candidate
git commit -m "Deploy ${VERSION}-rc${CANDIDATE_NUM} docs"
git push origin gh-pages
```
## Update Versions For Development
Update `pom.xml` with the next SNAPSHOT version either manually or using Github Versions Plugin.
For RELEASE CANDIDATE, ignore this step.
```
git checkout main
# For release candidates, skip to push changes to main
VERSION=1.16.0-SNAPSHOT
mvn versions:set -DnewVersion=$VERSION
git add pom.xml
git commit -m "Update version for $VERSION development"
# Push changes to main
git push -u origin main
```
## Complete Release in Github
Currently the process to create more formal release notes and attach Assets is done manually through the [Github UI](https://github.com/NASA-PDS/validate/releases/new) but should eventually be automated via script.
*NOTE: Be sure to add the `tar.gz` and `zip` from the `target/` directory to the release assets, and use the CHANGELOG generated above to create the RELEASE NOTES.*
# Snapshot Release
Deploy software to Sonatype SNAPSHOTS Maven repo:
```
# Operational release
mvn clean site deploy
```
# Maven JAR Dependency Reference
## Operational Releases
https://search.maven.org/search?q=g:gov.nasa.pds%20AND%20a:validate&core=gav
## Snapshots
https://oss.sonatype.org/content/repositories/snapshots/gov/nasa/pds/validate/
If you want to access snapshots, add the following to your `~/.m2/settings.xml`:
```
allow-snapshots
true
snapshots-repo
https://oss.sonatype.org/content/repositories/snapshots
false
true
```