From 9cedcfe0d70dbb793dc4c314071ca30964c55fdb Mon Sep 17 00:00:00 2001 From: Marc-Andre Laperle Date: Tue, 17 Jan 2017 17:14:15 -0500 Subject: [PATCH] releng: Add more script documentation, examples Change-Id: I87b8ee328055ce464c762555a5cf011fa8f70db5 Signed-off-by: Marc-Andre Laperle Reviewed-on: https://git.eclipse.org/r/88910 Reviewed-by: Hudson CI Reviewed-by: Bernd Hufmann Tested-by: Bernd Hufmann --- releng/scripts/check_mvn_plugin_versions.sh | 16 + releng/scripts/check_plugins_changes.sh | 3 +- .../scripts/generate_api_baseline_unit_ids.sh | 7 +- ...html_rcp_download_stats_to_csv_example.csv | 41 ++ ...tml_rcp_download_stats_to_csv_example.html | 608 ++++++++++++++++++ ...p_download_stats_to_csv_example.ods.README | 2 + releng/scripts/update_version.sh | 17 + 7 files changed, 691 insertions(+), 3 deletions(-) create mode 100644 releng/scripts/html_rcp_download_stats_to_csv_example.csv create mode 100644 releng/scripts/html_rcp_download_stats_to_csv_example.html create mode 100644 releng/scripts/html_rcp_download_stats_to_csv_example.ods.README diff --git a/releng/scripts/check_mvn_plugin_versions.sh b/releng/scripts/check_mvn_plugin_versions.sh index 5a68d036c4..5a6ac61ced 100755 --- a/releng/scripts/check_mvn_plugin_versions.sh +++ b/releng/scripts/check_mvn_plugin_versions.sh @@ -12,6 +12,22 @@ # Alexandre Montplaisir - Initial version ############################################################################### +# A script that checks for outdated Maven plugins being used by the +# build. The build specifies exact version of Maven plugins, for +# stability and reproducibility reasons. When a new plugin is +# available, the version has to be manually updated and the build has +# to be tested. +# +# What should be tested? Depending on the plugins that are updated: +# - Are the update sites OK? Categories, content, etc. (Tycho, JBoss) +# - Is the product OK? Starts, splash screen, etc. (Tycho) +# - Is code coverage still working? (Jacoco) +# +# The script simply formats the output of +# 'mvn versions:display-plugin-updates' in a nicer summary. +# +# Usage ./check_mvn_plugin_versions.sh + # Point ourselves to the script's directory (so it can be run "out-of-tree") DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) output=`mvn versions:display-plugin-updates -U -f $DIR/../../pom.xml` diff --git a/releng/scripts/check_plugins_changes.sh b/releng/scripts/check_plugins_changes.sh index 5c7d56f6ec..d3b7c382ca 100755 --- a/releng/scripts/check_plugins_changes.sh +++ b/releng/scripts/check_plugins_changes.sh @@ -9,7 +9,8 @@ ############################################################################### # A script that checks every plugin for modifications since last release -# and prompt to bump the micro version if necessary. +# and prompt to bump the micro version if necessary. Major and minor +# version changes are handled by the API tooling already. # # Usage ./check_plugins_changes.sh [ignoredCommit1,ignoredCommit2,...] # diff --git a/releng/scripts/generate_api_baseline_unit_ids.sh b/releng/scripts/generate_api_baseline_unit_ids.sh index b04ab1d460..3acd22503a 100755 --- a/releng/scripts/generate_api_baseline_unit_ids.sh +++ b/releng/scripts/generate_api_baseline_unit_ids.sh @@ -8,7 +8,10 @@ # http://www.eclipse.org/legal/epl-v10.html ############################################################################### -# Generates a list of plugins suitable to be put in the API baseline. It skips test plugins, rcp and doc. +# Generates a list of plugins suitable to be put in the API baseline. +# It skips test plugins, rcp and doc. +# +# Usage ./generate_api_baseline_unit_ids.sh -find ../.. -name "MANIFEST.MF" | grep -v -E 'doc|rcp|tests' | cut -c 3- | xargs -n1 dirname | xargs -n1 dirname | sed -rn s/.*\\/\(.*\)/\\1/p | sort | xargs -n1 -I {} echo '' +find ../.. -name "MANIFEST.MF" | grep -v -E 'doc|rcp|tests|/target/' | cut -c 3- | xargs -n1 dirname | xargs -n1 dirname | sed -rn s/.*\\/\(.*\)/\\1/p | sort | xargs -n1 -I {} echo '' diff --git a/releng/scripts/html_rcp_download_stats_to_csv_example.csv b/releng/scripts/html_rcp_download_stats_to_csv_example.csv new file mode 100644 index 0000000000..a0f506f61b --- /dev/null +++ b/releng/scripts/html_rcp_download_stats_to_csv_example.csv @@ -0,0 +1,41 @@ +1.2.1,linux,x86_64,115 +1.2.1,win32,x86_64,95 +2.1.0,win32,x86_64,82 +2.0.0,win32,x86_64,57 +2.0.0,linux,x86_64,49 +1.2.0,linux,x86_64,47 +2.1.0,linux,x86_64,45 +2.0.1,win32,x86_64,40 +2.0.1,linux,x86_64,34 +1.2.1,win32,x86,32 +1.2.1,linux,x86,24 +1.1.0,win32,x86_64,21 +2.1.0,win32,x86,20 +1.2.0,win32,x86_64,19 +2.0.1,win32,x86,17 +1.1.0,linux,x86_64,16 +2.0.0,win32,x86,16 +2.0.0,linux,x86,14 +2.2.0,win32,x86_64,13 +2.0.1,linux,x86,12 +2.2.0,linux,x86_64,11 +1.2.1,macosx,x86_64,9 +2.0.1,macosx,x86_64,9 +1.2.0,win32,x86,8 +1.2.0,macosx,x86_64,7 +0.1.0,linux,x86_64,7 +0.1.0,win32,x86_64,6 +2.2.0,macosx,x86_64,6 +2.1.0,linux,x86,6 +2.1.0,macosx,x86_64,5 +1.0.0,win32,x86_64,4 +1.1.0,win32,x86,4 +0.1.0,linux,x86,3 +1.2.0,linux,x86,3 +1.0.0,linux,x86_64,3 +1.0.0,linux,x86,2 +2.2.0,linux,x86,2 +1.0.0,win32,x86,2 +0.1.0,win32,x86,2 +1.1.0,linux,x86,1 +2.2.0,win32,x86,1 diff --git a/releng/scripts/html_rcp_download_stats_to_csv_example.html b/releng/scripts/html_rcp_download_stats_to_csv_example.html new file mode 100644 index 0000000000..c51a42f9b3 --- /dev/null +++ b/releng/scripts/html_rcp_download_stats_to_csv_example.html @@ -0,0 +1,608 @@ + + + + + + + + + + + Eclipse Download Stats + + + + + + + + + + + + + + + + + + + Skip to main content +
+
+
+
+ +
+
+
+
+
+
+ +
+

Eclipse Download Stats

+ + +

Download requests are recorded two ways: by using the Find A Mirror script, and by configuring your p2 repository. Direct downloads from mirrors and files linked directly to download.eclipse.org are not included here.

+

Search Criteria

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Partial File Name: + + +
TIP: For faster results, use a file name that matches the fewest amount of files as possible to satisfy your query. For instance, query using the core file(s) that make up one user download.
 
Group files
 
+ 		+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Please note: Using the filter options below causes queries to run against 509,215,070 download records, from 0000-00-00 to 2017-01-17 09:16:03. Today's downloads will be added at midnight Eastern Time.
Date + + +
OR
Date From:
Date To:
TIP: date-based queries take much longer to run when files with tens of thousands of downloads are included.
 
View + +
+
+
+ +

Results

+ + + + Query took 0.820 sec + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
File (click for daily stats)Count
/tracecompass/releases/1.2.1/rcp/trace-compass-1.2.1-20160323-2336-linux.gtk.x86_64.tar.gz115
/tracecompass/releases/1.2.1/rcp/trace-compass-1.2.1-20160323-2336-win32.win32.x86_64.zip95
/tracecompass/releases/2.1.0/rcp/trace-compass-2.1.0-20160917-1952-win32.win32.x86_64.zip82
/tracecompass/releases/2.0.0/rcp/trace-compass-2.0.0-20160608-1429-win32.win32.x86_64.zip57
/tracecompass/releases/2.0.0/rcp/trace-compass-2.0.0-20160608-1429-linux.gtk.x86_64.tar.gz49
/tracecompass/releases/1.2.0/rcp/trace-compass-1.2.0-20160209-0500-linux.gtk.x86_64.tar.gz47
/tracecompass/releases/2.1.0/rcp/trace-compass-2.1.0-20160917-1952-linux.gtk.x86_64.tar.gz45
/tracecompass/releases/2.0.1/rcp/trace-compass-2.0.1-20160805-1655-win32.win32.x86_64.zip40
/tracecompass/releases/2.0.1/rcp/trace-compass-2.0.1-20160805-1655-linux.gtk.x86_64.tar.gz34
/tracecompass/releases/1.2.1/rcp/trace-compass-1.2.1-20160323-2336-win32.win32.x86.zip32
/tracecompass/releases/1.2.1/rcp/trace-compass-1.2.1-20160323-2336-linux.gtk.x86.tar.gz24
/tracecompass/releases/1.1.0/rcp/trace-compass-1.1.0-20150921-1806-win32.win32.x86_64.zip21
/tracecompass/releases/2.1.0/rcp/trace-compass-2.1.0-20160917-1952-win32.win32.x86.zip20
/tracecompass/releases/1.2.0/rcp/trace-compass-1.2.0-20160209-0500-win32.win32.x86_64.zip19
/tracecompass/releases/2.0.1/rcp/trace-compass-2.0.1-20160805-1655-win32.win32.x86.zip17
/tracecompass/releases/1.1.0/rcp/trace-compass-1.1.0-20150921-1806-linux.gtk.x86_64.tar.gz16
/tracecompass/releases/2.0.0/rcp/trace-compass-2.0.0-20160608-1429-win32.win32.x86.zip16
/tracecompass/releases/2.0.0/rcp/trace-compass-2.0.0-20160608-1429-linux.gtk.x86.tar.gz14
/tracecompass/releases/2.2.0/rcp/trace-compass-2.2.0-20161221-1532-win32.win32.x86_64.zip13
/tracecompass/releases/2.0.1/rcp/trace-compass-2.0.1-20160805-1655-linux.gtk.x86.tar.gz12
/tracecompass/releases/2.2.0/rcp/trace-compass-2.2.0-20161221-1532-linux.gtk.x86_64.tar.gz11
/tracecompass/releases/1.2.1/rcp/trace-compass-1.2.1-20160323-2336-macosx.cocoa.x86_64.tar.gz9
/tracecompass/releases/2.0.1/rcp/trace-compass-2.0.1-20160805-1655-macosx.cocoa.x86_64.tar.gz9
/tracecompass/releases/1.2.0/rcp/trace-compass-1.2.0-20160209-0500-win32.win32.x86.zip8
/tracecompass/releases/1.2.0/rcp/trace-compass-1.2.0-20160209-0500-macosx.cocoa.x86_64.tar.gz7
/tracecompass/releases/0.1.0/rcp/trace-compass-0.1.0-20150225-1602-linux.gtk.x86_64.tar.gz7
/tracecompass/releases/0.1.0/rcp/trace-compass-0.1.0-20150225-1602-win32.win32.x86_64.zip6
/tracecompass/releases/2.2.0/rcp/trace-compass-2.2.0-20161221-1532-macosx.cocoa.x86_64.tar.gz6
/tracecompass/releases/2.1.0/rcp/trace-compass-2.1.0-20160917-1952-linux.gtk.x86.tar.gz6
/tracecompass/releases/2.1.0/rcp/trace-compass-2.1.0-20160917-1952-macosx.cocoa.x86_64.tar.gz5
/tracecompass/releases/1.0.0/rcp/trace-compass-1.0.0-20150610-1449-win32.win32.x86_64.zip4
/tracecompass/releases/1.1.0/rcp/trace-compass-1.1.0-20150921-1806-win32.win32.x86.zip4
/tracecompass/releases/0.1.0/rcp/trace-compass-0.1.0-20150225-1602-linux.gtk.x86.tar.gz3
/tracecompass/releases/1.2.0/rcp/trace-compass-1.2.0-20160209-0500-linux.gtk.x86.tar.gz3
/tracecompass/releases/1.0.0/rcp/trace-compass-1.0.0-20150610-1449-linux.gtk.x86_64.tar.gz3
/tracecompass/releases/1.0.0/rcp/trace-compass-1.0.0-20150610-1449-linux.gtk.x86.tar.gz2
/tracecompass/releases/2.2.0/rcp/trace-compass-2.2.0-20161221-1532-linux.gtk.x86.tar.gz2
/tracecompass/releases/1.0.0/rcp/trace-compass-1.0.0-20150610-1449-win32.win32.x86.zip2
/tracecompass/releases/0.1.0/rcp/trace-compass-0.1.0-20150225-1602-win32.win32.x86.zip2
/tracecompass/releases/1.1.0/rcp/trace-compass-1.1.0-20150921-1806-linux.gtk.x86.tar.gz1
/tracecompass/releases/2.2.0/rcp/trace-compass-2.2.0-20161221-1532-win32.win32.x86.zip1
41 records found.869
+
+
+

+ Back to the top +

+ + + + + + + diff --git a/releng/scripts/html_rcp_download_stats_to_csv_example.ods.README b/releng/scripts/html_rcp_download_stats_to_csv_example.ods.README new file mode 100644 index 0000000000..259a7c569d --- /dev/null +++ b/releng/scripts/html_rcp_download_stats_to_csv_example.ods.README @@ -0,0 +1,2 @@ +An example spread sheet for the viewing of the stats is available here: +https://wiki.eclipse.org/File:Tracecompass-Html_rcp_download_stats_to_csv_example.ods.zip diff --git a/releng/scripts/update_version.sh b/releng/scripts/update_version.sh index ffb6967ca8..98d3716d1b 100755 --- a/releng/scripts/update_version.sh +++ b/releng/scripts/update_version.sh @@ -7,6 +7,23 @@ # http://www.eclipse.org/legal/epl-v10.html ############################################################################### +# Updates the version numbers of the project +# +# Which versions are updated? At the time of writing, plug-ins with +# code are updated when the API changes (API additions or breakage) +# by using the API tooling inside Eclipse. So this script does not +# deal with those. +# Things that follow the project version number (subject to change): +# - Features +# - Documentation plugins +# - Product related stuff (about text, branding plugins, etc) +# - Parent pom version + +# Usage ./update_version.sh oldversion newversion +# For example ./update_version.sh 2.1.0 2.2.0 +# +# Note that can also make the version go backwards if needed. + oldVersion=$1 newVersion=$2 -- 2.34.1