Merge pull request #19 from apache/feature/update_after_release
Feature/update after release
diff --git a/publish.sh b/publish.sh
deleted file mode 100755
index 51429a8..0000000
--- a/publish.sh
+++ /dev/null
@@ -1,91 +0,0 @@
-#!/usr/bin/env 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.
-
-# A script to build the Celix site (based on Hugo)
-
-# Input parameters
-GIT_REMOTE=$1
-if [[ -z "${GIT_REMOTE}" ]]; then
- echo "Git remote is not specified!"
- echo ""
- echo "Usage:"
- echo " ./publish.sh <remote>"
- echo " e.g."
- echo " ./publish.sh origin"
- exit 1
-fi
-
-# specify source and site branches
-SOURCE="master"
-SITE="asf-site"
-
-# Make sure the SOURCE branch is active
-git checkout ${SOURCE} > /dev/null 2>&1
-
-# Get the latest commit SHA in SOURCE branch
-last_SHA=( $(git log -n 1 --pretty=format:"%H") )
-
-# Create a temporary folder
-tmp_dir=`mktemp -d`
-out_dir=${tmp_dir}/content
-mkdir -p ${out_dir}
-
-# Build the site to our temporary folder
-hugo --destination ${out_dir} > /dev/null 2>&1
-if [ $? = 0 ]; then
- echo "Hugo build successful"
-else
- echo "Hugo build failed"
- exit 1
-fi
-
-# Switch to the SITE branch
-git checkout ${SITE} > /dev/null 2>&1
-
-# Remove the current contents of the SITE branch and replace them with the contents of the temp folder
-current_dir=${PWD}
-rm -rf ${current_dir}/content
-git rm -r --cached content/* > /dev/null 2>&1
-mkdir -p ${current_dir}/content
-cp -rT ${tmp_dir}/* ${current_dir}/content
-
-# Commit the changes to the SITE branch
-message="Updated site from ${SOURCE} (${last_SHA})"
-git add -A
-git commit -m "${message}" > /dev/null 2>&1
-
-# Delete the temporary folder
-rm -rf ${tmp_dir}
-
-# Push the SOURCE to the server
-git push -u ${GIT_REMOTE} ${SOURCE} > /dev/null 2>&1
-if [ $? = 0 ]; then
- echo "Push ${SOURCE} successful"
-else
- echo "Push ${SOURCE} failed"
-fi
-
-# Push the SITE to the server
-git push -u ${GIT_REMOTE} ${SITE} > /dev/null 2>&1
-if [ $? = 0 ]; then
- echo "Push ${SITE} successful"
-else
- echo "Push ${SITE} failed"
-fi
-
-# Switch back to SOURCE branch
-git checkout ${SOURCE} > /dev/null 2>&1
diff --git a/source/contributing/releasing.md b/source/contributing/releasing.md
index a025b85..9394e1c 100644
--- a/source/contributing/releasing.md
+++ b/source/contributing/releasing.md
@@ -26,11 +26,11 @@
The generated key can be uploaded to the [MIT PGP Public Key Server](https://pgp.mit.edu/).
-Next, the public key signature must be added to the KEYS file. Again, read the [Signing Releases page](https://www.apache.org/dev/release-signing.html#keys-policy)
-for more information. This updated file needs to be uploaded to GIT, be sure to upload it to:
+Next, the public key signature must be added to the [Celix KEYS file](https://downloads.apache.org/celix/KEYS).
+Again, read the [Signing Releases page](https://www.apache.org/dev/release-signing.html#keys-policy) for more
+information. This updated file needs to be uploaded to SVN at the following location:
-* [Apache Celix release development area KEYS](https://dist.apache.org/repos/dist/dev/celix/KEYS)
-* [Apache Celix release distribution area KEYS](https://downloads.apache.org/celix/KEYS)
+* [Apache Celix release distribution area KEYS](https://dist.apache.org/repos/dist/release/celix/KEYS)
## Create release branch
@@ -115,8 +115,8 @@
## Create, sign and publish artifacts
-Since Celix only releases source artifacts, creating the artifact is simple and straightforward
-First verify that all changes are committed to the release branch and the branch is pushed to github
+Since Celix only releases source artifacts, creating the artifact is simple and straightforward.
+First verify that all changes are committed to the release branch and the branch is pushed to GitHub.
```bash
# Create symbolic link so the archive has a directory with version information
@@ -283,6 +283,8 @@
* Run the [extract_celix_docs.sh]({{< site_src "extract_celix_docs.sh" >}}) script to copy the markdown documentation within the Celix code base
to the website.
* Verify whether the documentation is correctly copied & otherwise make some minor tweaks.
+* Create a `docs.md` file within the release documentation directory (example path: `source/docs/2.2.1/docs.md`, where 2.2.1 needs to be
+ substituted with the actual released version). This file can be copied and updated from e.g. a previous release.
* Check-in the documentation and create a pull request to the [celix-site]({{< param "siteRepositoryUrl" >}}) repository for the Celix team to review.
Once the site is updated proceed with announcing the release.
