Skip to content

Fork.md

Latest commit

 

History

History
100 lines (78 loc) · 3.71 KB

Fork.md

File metadata and controls

100 lines (78 loc) · 3.71 KB
Raw

YAMLStar SnakeYAML Engine fork

This fork starts at canonical upstream tag snakeyaml-engine-3.2:

The Java implementation, package names, Apache 2.0 license, and upstream attribution are retained. Initial changes cover build and publication ownership only. The project that previously used Engine 2.7 must validate the upgrade to 3.2. Builds check formatting and licenses without rewriting source files.

Build

Makes installs Maven and Java under .cache/.

make test
make install
make bundle

bundle signs the main JAR, sources, Javadoc, and POM using Maven's release profile and the GPG key specified in ~/.yamlstar-secrets.yaml. It creates target/central-publishing/central-bundle.zip with uploading disabled, using the Central plugin's skipUpload option.

Release

Verify ownership of org.yamlstar in the Central Portal first. The release command reads java.token (falling back to central.token) and gpg.key-id from ~/.yamlstar-secrets.yaml, using the same credential format as YAMLStar. It also reads the optional gpg.passphrase. The signing key must be available to GPG. No Maven settings file or Maven-home override is needed.

Run the release yourself from a clean master checkout:

make release v=3.2.1

Use a=1 to release from another named branch:

make release v=3.2.1 a=1

Add d=1 to preview preparation without credentials, Maven execution, source changes, commits, tags, or uploading:

make release v=3.2.1 a=1 d=1

The requested version must be a newer patch version than pom.xml. The workflow rejects dirty checkouts, detached HEAD, and existing release tags. After confirmation, it updates the project version and SCM tag in pom.xml, VERSION in the Makefile, this document, and src/changes/changes.xml. An existing changelog entry retains its actions and receives the release date; otherwise the workflow adds a release entry. It runs Maven tests against the prepared version, creates a release commit and an annotated version tag, then signs and uploads the artifacts. Git remotes are not modified.

If tests fail, the prepared files remain uncommitted for inspection. No release commit, tag, or upload is made. If signing or uploading fails after testing, the release commit and tag remain. Retry only the upload with:

make release-upload v=3.2.1

The retry requires a clean checkout with the requested version tag at HEAD. It does not bump versions or create another commit or tag. Do not retry uploading a version already published on Central.

Use 3.2.1, 3.2.2, and later patch versions for additional fork releases based on upstream 3.2. Record the exact upstream base in the release notes. When adopting upstream 3.3, start the fork's new line at 3.3.0. That change requires explicitly preparing the new upstream baseline first. The parser plugin pins its Engine dependency, so adopting a newer fork version also requires a plugin release with rebuilt native libraries.

CENTRAL_TOKEN, GPG_KEY_ID, and GPG_PASSPHRASE environment variables can override file values. YS_SECRETS_FILE selects an alternative secrets file. The helper passes credentials through environment variables and temporary Maven settings containing only variable references.

Automatic publication is disabled. Review and publish the deployment in the Central Portal, then verify all four artifacts and signatures under org/yamlstar/snakeyaml-engine/3.2.1. Release the parser plugin only after the Engine artifacts are downloadable.