Skip to content
Permalink
Browse files
adding release and development documentation
  • Loading branch information
darkma773r committed Aug 21, 2021
1 parent 6923331 commit 5944830ffb7645a58f6764fcd5c88af9045ff70d
Showing 5 changed files with 1,051 additions and 0 deletions.
@@ -0,0 +1,30 @@
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

This document summarizes the development process of Commons Geometry:

1. The "master" branch collects all modifications that will be part
of the next release.
Usually, non trivial changes should not be committed directly to the "master"
branch; they should be merged from a branch specifically created for
that purpose (see next point).
2. Work on an identified issue (bug fix or new feature) must be done in a
new branch named after its corresponding report in the bug-tracking
system (JIRA), e.g. "feature-GEOMETRY-123".
After completion, and in the absence of technical objections, the feature
branch is merged into the "master" branch, using the "--no-ff" git
option.
That feature branch is then deleted.
@@ -0,0 +1,56 @@
#!/bin/bash
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -e

# List of all modules paths for which the long-term Javadoc links must be copied
# We keep only the official distribution (i.e. _not_ "commons-geometry-examples").
MODULES=(commons-geometry-core \
commons-geometry-euclidean \
commons-geometry-spherical \
commons-geometry-io-core \
commons-geometry-io-euclidean)

while getopts r:v: option
do
case "${option}"
in
r) REVISION=${OPTARG};;
v) VERSION=${OPTARG};;
esac
done

if [ "$REVISION" == "" ]; then
echo "Missing SVN revision: Specify '-r <svn commit id>'";
exit 1;
fi

if [ "$VERSION" == "" ]; then
echo "Missing component version: Specify '-v <component version id>'";
exit 1;
fi

for mod in ${MODULES[@]}; do
echo $mod
CPLIST+=" cp $REVISION $mod/apidocs $mod/javadocs/api-$VERSION"
done

echo -n "Copying long-term links ... "
svnmucc -U https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-geometry \
$CPLIST \
-m "Commons Geometry: Copying $VERSION apidocs to versioned directories for the long-term links."
echo "Done."

0 comments on commit 5944830

Please sign in to comment.