Apache F U L C R U M

D E S C R I P T I O N

Fulcrum is a collection of components originally part of the Turbine core project that are suitable for use in any environment. They are designed to be used within any Avalon-compatible container.

Notice

This is the new Git module repository (replacing the old read-only https://github.com/apache/turbine-fulcrum-build.git) pointing to the indivdual Fulcrum component repositories.

U S A G E

Apache Fulcrum components might be used standalone, e.g. Fulcrum Crypto, but most components work best in an environment which uses the Fulcrum Yaafi service framework (which is using the Avalon service lifecycle interfaces aka Avalon container).

You can find a web framework, which is powered by Fulcrum here: Apache Turbine.

B U I L D I N G

You must have Maven 3.x

Building the Fulcrum from GIT is very easy. Fulcrum has been Maven-enabled. Please refer to the Maven Getting Started document for instructions on building. This document is available here:

https://maven.apache.org/guides/getting-started/

GIT

You could use git to checkout current trunk:

 git clone https://gitbox.apache.org/repos/asf/turbine-fulcrum-build.git 

N.B. The submodules are included with a relative URL. That is you decide if fetching with https + Github (no push) or with SSH or fetching from gitbox (recommended).

If you did a normal clone you have to init the submodules from the root folder with

git submodule update --init --remote

This will register and clone all submodules in one step.

Hint: To limit history e.g. to 10 commits add --depth 10.

Update all Fulcrum submodules to master (assuming default branch is "master")

git submodule foreach "git checkout master || :"

To update all submodules:

 git pull --recurse-submodules 

or equivalently:

git submodule update --init --remote 

git submodule sync

or: git submodule foreach git pull

To init or merge and fast-forward a single module:

git submodule update --init --remote <module>

or later

git submodule update --remote --merge <module>

or change into submodule

cd <submodule>
git checkout master
git pull

After having done this, check with

git status

and add the changed submodules (untracked contents, new commits" :

git add <submodule>
git commit "updated submodule <>"

Documentation

Each component has its section here.

Check all components e.g. by running

git submodule foreach "git checkout master"

git submodule foreach "mvn clean install || :"

Requirements

Fulcrum Components requires Java 8. Older components might require Java 7 only.

COMPONENT DEVELOPMENT

Adding Fulcrum component

git submodule add https://gitbox.apache.org/repos/asf/turbine-fulcrum-upload.git upload

This will immediately clone the repo into folder upload.

Edit in pom and add module

 <module>upload</module> 

Test it, by running mvn install

Caution! Before adding a submodule (after a change) to the container project (that is this project), be sure, that you have pushed your commits to the remote repo. If you forget this, another person may not be able to update the sub module in the container project.

Contributing

Please feel free to contribute. We are always happy to encourage new committers to the project.

The Apache Software foundation requires that any contributor has signed the ICLA (Individual Contributor License Agreement).

Find an overview, more information and how-tos here.

Publishing Workflow

Prerequisites

Deploy jars

mvn deploy -Papache-release

More Information:

• Maven Component Reference
• Apache Release Publishing

Steps

1. Local Testing

Verify gpg.homedir, gpg.useagent, gpg.passphrase. Check, if -Dgpg.useagent=false is needed, see below comment to pinentry. You may need to add additional profiles, e.g. -Papache-release,java8 or add -Dgpg.passphrase=

mvn clean site install -Papache-release 

Multi Module

mvn release:prepare -DdryRun=true -DautoVersionSubmodules=true -Papache-release

If security check is deactived by default (since parent pom v12):

mvn org.owasp:dependency-check-maven:aggregate -DskipTests=true -Ddependency.check.skip=false

Single

If dependency check is skipped by default, do mvn org.owasp:dependency-check-maven:check -Ddependency.check.skip=false Since Turbine Parent 8 security check is enabled by default.

mvn release:prepare -DdryRun=true -Papache-release -Dtag=<project.artifact>-<version>-candidate

Here the tag is already set.

And finally:

mvn release:clean    

2. Remote Testing

As we using GIT as SCM, be sure that you execute the steps in the master|trunk|main branch as GIT commands are applied to the current branch.

Find more Information in Turbine Release Manual.

If you have not set ssh-key or gpg authentication, the tasks may require that you explicitely authenticate with -Dusername= -Dpassword=.

Multi Module

mvn release:prepare -DautoVersionSubmodules=true -Papache-release -Dtag=<project.artifact>-<version>-candidate

Important: Success will be on the master build, the others are skipped.

Single

mvn release:prepare -Papache-release -Dtag=<project.artifact>-<version>-candidate

3. Release Preparing

If you get a 401 error on the upload to repository.apache.org, make sure that your mvn security settings are in place ~/.m2/settings.xml and ~/.m2/settings-security.xml

For more information on setting up security see the encryption guide:

• GUIDE ENCRYPTION.

This performs an upload to https://repository.apache.org/#stagingRepositories

Hint: Add -Dgpg.useagent=false helps, if running from a windows machine to avoid hanging while gpg plugin signing process .. this may happen, if you do not define the pinentry-program in gpg-agent.conf correctly ..

mvn release:perform

You could find more information here: Book Reference Staging

4. Close the staging

Login and close in Nexus Repo:

• Staging

More information available: CLOSE STAGE.

Fetch the URL for the tagged Repo from target/checkout with

git pull --prune --tags
git tag -l 
git checkout <tag>

You will be in detached mode.

5. Prepare Voting Information and Voting

....

6. Either Promote / Publish or Drop and Restage

• PROMOTE INFO
• DROP INFO

6a Promote / Release

• Release staged repository in nexus

• Rename (replace) the GIT tag -candidate to . Find more Information in Turbine Release Manual.

• Proceed with next step.

6b Revert

• Drop "reverse merge" the release prepare. If backup files (from release:prepare) are still there:

  mvn release:rollback

which will delete the tag in git repo tag and revert to the pre-release state.

Otherwise reset the commit in master in your checked out trunk/master/main branch

git reflog
// find commit previous to release
git reset –hard <shacommit>
git commit "Reset RC to state previous RC due to <Message-ID>"
git push -f origin master

and update master repo and delete the tag manually.

git push origin :refs/tags/<project.artifact>-<version>-candidate

• Drop staged repository in nexus and start again with step 1.

• Don't forget to refer to the failed vote Message-ID in the commit messages (git, nexus).

7. Distribution

• (http://www.apache.org/dev/release#upload-ci),

• http://www.apache.org/dev/release.html#host-GA and

• http://www.apache.org/dev/release-publishing.html#distribution

• Update branch asf-site in Fulcrum component root: Copy files from target/staging to the root of branch asf-site and commit. This will trigger (with .asf.yaml configuration) an update to the distribution site.

• SVN checkout target distribution from https://dist.apache.org/repos/dist/release/turbine/<...>/<...>

• SVN checkout released source from https://svn.apache.org/repos/asf/turbine/<..>/tags/<..>

• Generate artifacts (check local repo and target for artifacts) from released version:

Checkout the tagged released release and run:

mvn clean install package -Papache-release 

Generate checksums with UNIX tool shasum (2022 at least sha512), Windows certutil or other tools and copy artifacts and sha-files to dist source/binaries folder.

If not all jars are included (assembly plugin SHOULD run after jar generation), run a second time without clean. If no sha512 files are in the target folder, check local repo.

• SVN Add , artifacts (jar/zip/tar.gz,asc,sha512 files) to target repo.
• SVN Remove old releases binaries and sources

After repos/dist is updated an automatic email will be generated, if no update of the release database is done:

• ADD TO TURBINE RELEASE APACHE

8. Stage the latest documentation

• DEPLOY DOCU

Git Checkout source. Generate and Publish Site

Description of the process using asf-site branch using GIT commands

Hint: If checking out the branch asf-site you find an .asf.yaml file, where the exact configuration is found, what happens after site generation.

Find more information here.

• Generate the site in master branch and optionally save it somewhere

Single Module

mvn site

Multi Module

mvn site site:stage

• Save target/site or target/staging into another folder (target may be ignored, but to be sure)

• checkout branch asf-site. Verify proper settings in .asf.yaml providing at least this line:

  whoami: asf-site

• Copy content of saved copy or target/site (single module), target/staging (multi module) to the root of the branch

• Commit and push (this triggers the site update, if not contact INFRA)

Maven Publishing

The second steps are not yet tested with GIT repos (2021). Use instead the workflow above (using GIT commands).

Multi Module

mvn clean site site:stage
mvn scm-publish:publish-scm -Dscmpublish.dryRun=true

Single

Omit site:stage, which reqires site element definition in distributionManagement

mvn site scm-publish:publish-scm -Dscmpublish.dryRun=true
mvn clean site scm-publish:publish-scm -Dusername=<username> -Dpassword=<pw>

Deployment

To deploy the site execute

mvn site-deploy

IMPORTANT: You may have to clean up the checkoutDirectory of maven-scm-publish-plugin plugin after doing a dry run! This directory is configured in turbine-parent by default outside target folder:

turbine.site.cache: ${user.home}/turbine-sites

Check pom.xml configuration of properties.

License

Apache Fulcrum Components are distributed under the Apache License, version 2.0.