[struts-site] branch contributors-guide updated: Converts new pages related to creating distro
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git The following commit(s) were added to refs/heads/contributors-guide by this push: new a5f1513 Converts new pages related to creating distro a5f1513 is described below commit a5f15136d4365af0db30003da3f985ea3a0bc7c4 Author: Lukasz Lenart AuthorDate: Tue Sep 29 09:07:10 2020 +0200 Converts new pages related to creating distro --- source/contributors/building-struts-master.md | 112 + .../creating-and-signing-a-distribution.md | 2 +- source/contributors/index.md | 7 +- source/contributors/obtaining-an-idea-license.md | 29 ++ source/contributors/one-time-steps.md | 2 +- source/contributors/precise-error-reporting.md | 31 ++ 6 files changed, 177 insertions(+), 6 deletions(-) diff --git a/source/contributors/building-struts-master.md b/source/contributors/building-struts-master.md new file mode 100644 index 000..d1a60f9 --- /dev/null +++ b/source/contributors/building-struts-master.md @@ -0,0 +1,112 @@ +--- +layout: default +title: Building Struts Master +parent: + title: Contributors Guide + url: index.html +--- + +# Building Struts Master +{:.no_toc} + +* Will be replaced with the ToC, excluding a header +{:toc} + +## Building Steps (Struts) + +### Obtain a fresh checkout + +``` +git clone https://gitbox.apache.org/repos/asf/struts-master.git +``` + +### Change site target + +Apply needed changes, in most cases it will be upgrade to the latest Apache Parent POM, eg. from 9 to 10, +commit the change. + +### Prepare release + +Tag the release by using the "release:prepare" goal of Maven: + +``` +mvn release:prepare -DautoVersionSubmodules=true +``` + +For a [dry run](http://maven.apache.org/plugins/maven-release-plugin/usage.html), add `-DdryRun=true`. If you do a dry run, +use `mvn release:clean` to clean up after you have looked at the output. + +When prompted for the SCM tag name, follow this pattern: `STRUTS_MASTER_[PATCH_VERSION]` + +If for some reason, the release plugin might fail to tag the release, if it fails, run: + +``` +mvn release:prepare -Dresume +``` + +This step will ([more information](http://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html)): + +- Check that there are no uncommitted changes in the sources +- Check that there are no SNAPSHOT dependencies +- Change the version in the poms from x-SNAPSHOT to a new version (you will be prompted for the versions to use) +- Transform the SCM information in the POM to include the final destination of the tag +- Run the project tests against the modified POMs to confirm everything is in working order +- Commit the modified POMs +- Tag the code in the SCM with a version name (this will be prompted for) +- Bump the version in the POMs to a new value y-SNAPSHOT (these values will also be prompted for) +- Commit the modified POMs + +### Perform the release + +``` +mvn release:perform +``` + +This step will ([more information](http://maven.apache.org/plugins/maven-release-plugin/examples/perform-release.html)): + +- Checkout from an SCM URL with optional tag +- Run the predefined Maven goals to release the project (by default, deploy site-deploy) + +After this step the artifacts will be hosted by [Nexus](http://repository.apache.org/) + +If you need to run perform again, (or in a different box), do: + +``` +git co tags/$VERSION +mvn deploy site-deploy --no-plugin-updates -DperformRelease=true +``` + +Next, log in to [Nexus](http://repository.apache.org/) and **close** staging repository. + +### Announce availability + +Send a short e-mail to `dev@struts.a.o` informing about the new packages and to give people enough time to test +the distribution (actual bits). Wait around a week before posting Vote. If no show-stoppers reported, start a vote +thread for build quality designation. + +The new build is available from staging repository: `https://repository.apache.org/content/groups/staging/org/apache/struts/struts-master/[PATCH_VERSION]/` + +### Vote on it + +Post a release/quality vote to the dev list (and **only** the dev list). The example mail is on [Sample Announcements](sample-announcements) page. + +If the vote result is for an ASF release (i.e. not test build), update site, announce. If the vote result is for GA, push to central. + +### Promote release + +Log in again to [Nexus](http://repository.apache.org/) and **release** the repository, it will be automatically replicated across Maven Repositories + +See [Releasing a Maven-based project](http://maven.apache.org/developers/release/apache-release.html) for further details. + +### Wait for rsync + +Wait 2-6 hours before proceeding. + +### Post announcements + +We leave this as the last step, once the artifacts have had time to sync up o
[struts-site] 06/09: Uses the latest Maven summary
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git commit e45126da15529635a3a4ced5612de0caf3463594 Author: Lukasz Lenart AuthorDate: Fri Aug 14 11:26:03 2020 +0200 Uses the latest Maven summary --- source/contributors/building-with-maven.md | 91 -- 1 file changed, 37 insertions(+), 54 deletions(-) diff --git a/source/contributors/building-with-maven.md b/source/contributors/building-with-maven.md index 4c76bc4..7dc408c 100644 --- a/source/contributors/building-with-maven.md +++ b/source/contributors/building-with-maven.md @@ -52,65 +52,48 @@ core/target/struts2-core-2.0-SNAPSHOT.jar **Initial Build Successful** ``` +[INFO] [INFO] Reactor Summary: [INFO] -[INFO] Struts 2 .. SUCCESS [6.016s] -[INFO] XWork: Core ... SUCCESS [1:08.086s] -[INFO] Struts 2 Core . SUCCESS [2:42.604s] -[INFO] Struts Plugins SUCCESS [0.944s] -[INFO] Struts 2 Spring Plugin SUCCESS [13.523s] -[INFO] Struts 2 Convention Plugin SUCCESS [16.473s] -[INFO] Struts 2 JUnit Plugin . SUCCESS [13.325s] -[INFO] Webapps ... SUCCESS [1.027s] -[INFO] Blank Webapp .. SUCCESS [9.572s] -[INFO] JBoss Blank Webapp SUCCESS [7.814s] -[INFO] Mail Reader Webapp SUCCESS [7.028s] -[INFO] Struts 2 Portlet Plugin ... SUCCESS [20.995s] -[INFO] Struts 2 DWR Plugin ... SUCCESS [4.432s] -[INFO] Struts 2 Tiles Plugin . SUCCESS [4.451s] -[INFO] Struts 2 Portlet Tiles Plugin . SUCCESS [3.741s] -[INFO] Portlet Webapp SUCCESS [28.480s] -[INFO] Struts 2 Struts 1 Plugin .. SUCCESS [8.353s] -[INFO] Struts 2 Dojo Plugin .. SUCCESS [30.181s] -[INFO] Struts 2 JSF Plugin ... SUCCESS [6.000s] -[INFO] Struts 2 Configuration Browser Plugin . SUCCESS [7.531s] -[INFO] Struts 2 Sitemesh Plugin .. SUCCESS [6.159s] -[INFO] Struts 2 JSON Plugin .. SUCCESS [16.944s] -[INFO] Showcase Webapp ... SUCCESS [20.303s] -[INFO] Struts 2 REST Plugin .. SUCCESS [10.015s] -[INFO] Struts 2 Rest Showcase Example SUCCESS [6.928s] -[INFO] Struts 2 Codebehind Plugin SUCCESS [10.394s] -[INFO] Struts 2 Java Templates Plugin SUCCESS [9.633s] -[INFO] Struts 2 Jasper Reports Plugin SUCCESS [5.920s] -[INFO] Struts 2 JFreeChart Plugin SUCCESS [18.296s] -[INFO] Struts 2 Pell Multipart Plugin SUCCESS [3.891s] -[INFO] Struts 2 Plexus Plugin SUCCESS [4.715s] -[INFO] Struts 2 Sitegraph Plugin . SUCCESS [8.009s] -[INFO] Struts 2 TestNG Plugin SUCCESS [6.012s] -[INFO] Struts 2 OVal Plugin .. SUCCESS [9.629s] -[INFO] Struts 2 OSGi Plugin .. SUCCESS [8.118s] -[INFO] Struts 2 Embedded JSP Plugin .. SUCCESS [30.524s] -[INFO] Struts 2 GXP Plugin ... SUCCESS [4.878s] -[INFO] Struts 2 CDI Plugin ... SUCCESS [7.620s] -[INFO] Struts 2 Tiles 3 Plugin ... SUCCESS [5.132s] -[INFO] Struts OSGi Bundles ... SUCCESS [0.254s] -[INFO] Struts 2 OSGi Admin Bundle SUCCESS [5.204s] -[INFO] Struts 2 OSGi Demo Bundle . SUCCESS [4.582s] -[INFO] Struts 2 Maven Archetypes . SUCCESS [0.198s] -[INFO] Struts 2 Archetypes - Angular JS .. SUCCESS [10.509s] -[INFO] Struts 2 Archetypes - Blank ... SUCCESS [1.440s] -[INFO] Struts 2 Archetypes - Blank Convention SUCCESS [1.324s] -[INFO] Struts 2 Archetypes - Database Portlet SUCCESS [0.990s] -[INFO] Struts 2 Archetypes - Plugin .. SUCCESS [0.923s] -[INFO] Struts 2 Archetypes - Portlet . SUCCESS [0.888s] -[INFO] Struts 2 Archetypes - Starter . SUCCESS [1.992s] -[INFO] Struts 2 Assembly . SUCCESS [1:37.556s] +[INFO] Struts 2 Bill of Materials . SUCCESS [ 1.188 s] +[INFO] Struts 2 2.5.24-SNAPSHOT ..
[struts-site] 02/09: Drops WIP
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git commit ee45534328eb9f6331afd65d68ca665dcd8300db Author: Lukasz Lenart AuthorDate: Tue Jul 7 11:06:07 2020 +0200 Drops WIP --- source/core-developers/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/core-developers/index.md b/source/core-developers/index.md index 6a8c396..fdd2b0c 100644 --- a/source/core-developers/index.md +++ b/source/core-developers/index.md @@ -1,6 +1,6 @@ --- layout: default -title: Core Developers Guide (WIP) +title: Core Developers Guide --- # Core Developers Guide
[struts-site] 09/09: Converts new pages related to creating distro
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git commit 160cb672248e21b8cbebdf03af45af8f4c9ce76b Author: Lukasz Lenart AuthorDate: Tue Sep 29 09:07:10 2020 +0200 Converts new pages related to creating distro --- source/contributors/building-struts-master.md | 112 + .../creating-and-signing-a-distribution.md | 2 +- source/contributors/index.md | 7 +- source/contributors/obtaining-an-idea-license.md | 29 ++ source/contributors/one-time-steps.md | 2 +- source/contributors/precise-error-reporting.md | 31 ++ 6 files changed, 177 insertions(+), 6 deletions(-) diff --git a/source/contributors/building-struts-master.md b/source/contributors/building-struts-master.md new file mode 100644 index 000..d1a60f9 --- /dev/null +++ b/source/contributors/building-struts-master.md @@ -0,0 +1,112 @@ +--- +layout: default +title: Building Struts Master +parent: + title: Contributors Guide + url: index.html +--- + +# Building Struts Master +{:.no_toc} + +* Will be replaced with the ToC, excluding a header +{:toc} + +## Building Steps (Struts) + +### Obtain a fresh checkout + +``` +git clone https://gitbox.apache.org/repos/asf/struts-master.git +``` + +### Change site target + +Apply needed changes, in most cases it will be upgrade to the latest Apache Parent POM, eg. from 9 to 10, +commit the change. + +### Prepare release + +Tag the release by using the "release:prepare" goal of Maven: + +``` +mvn release:prepare -DautoVersionSubmodules=true +``` + +For a [dry run](http://maven.apache.org/plugins/maven-release-plugin/usage.html), add `-DdryRun=true`. If you do a dry run, +use `mvn release:clean` to clean up after you have looked at the output. + +When prompted for the SCM tag name, follow this pattern: `STRUTS_MASTER_[PATCH_VERSION]` + +If for some reason, the release plugin might fail to tag the release, if it fails, run: + +``` +mvn release:prepare -Dresume +``` + +This step will ([more information](http://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html)): + +- Check that there are no uncommitted changes in the sources +- Check that there are no SNAPSHOT dependencies +- Change the version in the poms from x-SNAPSHOT to a new version (you will be prompted for the versions to use) +- Transform the SCM information in the POM to include the final destination of the tag +- Run the project tests against the modified POMs to confirm everything is in working order +- Commit the modified POMs +- Tag the code in the SCM with a version name (this will be prompted for) +- Bump the version in the POMs to a new value y-SNAPSHOT (these values will also be prompted for) +- Commit the modified POMs + +### Perform the release + +``` +mvn release:perform +``` + +This step will ([more information](http://maven.apache.org/plugins/maven-release-plugin/examples/perform-release.html)): + +- Checkout from an SCM URL with optional tag +- Run the predefined Maven goals to release the project (by default, deploy site-deploy) + +After this step the artifacts will be hosted by [Nexus](http://repository.apache.org/) + +If you need to run perform again, (or in a different box), do: + +``` +git co tags/$VERSION +mvn deploy site-deploy --no-plugin-updates -DperformRelease=true +``` + +Next, log in to [Nexus](http://repository.apache.org/) and **close** staging repository. + +### Announce availability + +Send a short e-mail to `dev@struts.a.o` informing about the new packages and to give people enough time to test +the distribution (actual bits). Wait around a week before posting Vote. If no show-stoppers reported, start a vote +thread for build quality designation. + +The new build is available from staging repository: `https://repository.apache.org/content/groups/staging/org/apache/struts/struts-master/[PATCH_VERSION]/` + +### Vote on it + +Post a release/quality vote to the dev list (and **only** the dev list). The example mail is on [Sample Announcements](sample-announcements) page. + +If the vote result is for an ASF release (i.e. not test build), update site, announce. If the vote result is for GA, push to central. + +### Promote release + +Log in again to [Nexus](http://repository.apache.org/) and **release** the repository, it will be automatically replicated across Maven Repositories + +See [Releasing a Maven-based project](http://maven.apache.org/developers/release/apache-release.html) for further details. + +### Wait for rsync + +Wait 2-6 hours before proceeding. + +### Post announcements + +We leave this as the last step, once the artifacts have had time to sync up on the mirrors. Target it to: + +- user@struts.a.o +- announcements@struts.a.o + +samples are available at [Sample announcements](sample-announcements) page. diff --git a/sour
[struts-site] 04/09: Adds Contributors Guide to the menu
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git commit d9bd4708575b67307cd5f692633d6ce281005c62 Author: Lukasz Lenart AuthorDate: Mon Jul 20 08:41:21 2020 +0200 Adds Contributors Guide to the menu --- source/_includes/header.html | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_includes/header.html b/source/_includes/header.html index 53cb691..25b579f 100644 --- a/source/_includes/header.html +++ b/source/_includes/header.html @@ -79,6 +79,7 @@ You at Struts How to Help FAQ Development Lists +Contributors Guide Submitting patches Source Code and Builds
[struts-site] 07/09: Adds One time steps page
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git commit ee8f58b4d358a348ddaf62e7f1b6e4bf7e73fbed Author: Lukasz Lenart AuthorDate: Mon Aug 24 07:48:58 2020 +0200 Adds One time steps page --- .../creating-and-signing-a-distribution.md | 2 +- source/contributors/index.md | 2 +- source/contributors/one-time-steps.md | 128 + 3 files changed, 130 insertions(+), 2 deletions(-) diff --git a/source/contributors/creating-and-signing-a-distribution.md b/source/contributors/creating-and-signing-a-distribution.md index 372c003..2d6e11f 100644 --- a/source/contributors/creating-and-signing-a-distribution.md +++ b/source/contributors/creating-and-signing-a-distribution.md @@ -29,7 +29,7 @@ parent: Depends on what you want to achieve, please select topic from the list below: -- [One time steps](#PAGE_27832952) - before you start preparing a distribution +- [One time steps](one-time-steps) - before you start preparing a distribution - [Sample announcements](#PAGE_27832957) - announcements used to communicate the achievement - [Building Struts Master](#PAGE_27839549) - how to release Struts Master - [Building Struts Annotations](#PAGE_27832965) - when you want to prepare a new distribution of Struts Annotations (if something changed) diff --git a/source/contributors/index.md b/source/contributors/index.md index 4cad522..fa24924 100644 --- a/source/contributors/index.md +++ b/source/contributors/index.md @@ -9,7 +9,7 @@ title: Contributors Guide - [Building the Framework from Source](building-the-framework-from-source) - [Building with Maven](building-with-maven) -- [Creating and Signing a Distribution](#PAGE_26375) +- [Creating and Signing a Distribution](creating-and-signing-a-distribution) - [Requirements](#PAGE_29362) and [Use Cases](#PAGE_29364) - _under construction_ - [Precise Error Reporting](#PAGE_29826) - [Obtaining an IDEA license](#PAGE_29381) diff --git a/source/contributors/one-time-steps.md b/source/contributors/one-time-steps.md new file mode 100644 index 000..4b98cc2 --- /dev/null +++ b/source/contributors/one-time-steps.md @@ -0,0 +1,128 @@ +--- +layout: default +title: One time steps +parent: + title: Contributors Guide + url: index.html +--- + +# One time steps +{:.no_toc} + +* Will be replaced with the ToC, excluding a header +{:toc} + +## Keys and configuration + +### Create and install a SSH key + +| See [OpenSSH Public Key Authentication](http://sial.org/howto/openssh/publickey-auth/) + +If you get hung up during release:perform because Maven can't verify the authenticity of a host, then there could be +one of two different problems. The first problem, which is an easy fix, is to go to the command line and use SSH +to log in to that host. You should receive a prompt to add the host to your known_hosts file. If you add the host +to your `known_hosts` file from the command line SSH, then you should be able to try `release:perform` again +and have more success. There is a chance though that this won't fix maven. + +Maven doesn't appear to understand hashed `known_hosts` files. There is some information here - [known_hosts file Hashing](http://itso.iu.edu/Hashing_the_OpenSSH_known__hosts_File). + +If your `known_hosts` file is hashed, you can solve this one of a few different ways. If you perform a `deploy:deploy` +instead of `release:perform`, then maven will leave a prompt open for you to type `yes` and have maven add the host +(in a way that Jsch, the library which provides Maven Wagon with the SSH/SCP functionality, understands) +to your `known_hosts` file. Another option is to remove your `known_hosts` file, update your SSH configuration so that +it does not hash the hostname in `known_hosts` and try to log in from the command line. + +``` +mkdir ~/.ssh +chmod 700 ~/.ssh +ssh-keygen -q -f ~/.ssh/id_rsa -t rsa +#Enter a passphrase +chmod go-rwx ~/.ssh/* + +#copy the public key to people.apache.org +scp ~/.ssh/id_rsa.pub people.apache.org:/home/$USERNAME + +# next, setup the public key on server +ssh people.apache.org +mkdir ~/.ssh +chmod 700 ~/.ssh +cat ~/id_rsa.pub >> ~/.ssh/authorized_keys +chmod 600 ~/.ssh/authorized_keys +rm ~/id_rsa.pub +``` + +### Create a PGP key + +``` +svn co https://svn.apache.org/repos/asf/struts/maven/trunk/build struts-maven-build +cd struts-maven-build +(gpg --fingerprint --list-sigs && gpg --armor --export ) >> KEYS +scp KEYS people.apache.org:/www/www.apache.org/dist/struts +svn commit KEYS -m "Add public key" +``` + +### Update Maven settings for our servers + +Create a `settings.xml` under `~/.m2` and follow below instructions: +- create profile - [Releasing a Maven-based](http://maven.apache.org/developers/release/apache-release.html\#Prerequisites) +- enable Apache servers [Committer Setti
[struts-site] branch contributors-guide updated (a5f1513 -> 160cb67)
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a change to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git. discard a5f1513 Converts new pages related to creating distro omit 8a51d04 Add $-syntax to announcement omit a6a7a22 Add Announcement 2020-08-13 omit 3761b85 Make current 2019 announcement page archived omit fdd3e91 Adjust docker scripts and docs to remove start errors (bash) and allow local serving omit beb48b9 Add ignores for VS Code and Eclipse omit 2e0c2dd Adds small Struts logo omit c318651 Adds Sample Announcements page omit 032ccc8 Adds One time steps page omit 2afbca8 Uses the latest Maven summary omit 98cfcc5 Adding section how create a release omit d614723 Adds Contributors Guide to the menu omit aaaf7e3 Adds how to build omit fda9a83 Drops WIP omit b767d8d Creates Contributors Guide starting page add 5dd1805 Adds small Struts logo add 4accab4 Add ignores for VS Code and Eclipse add 6ec8abe Adjust docker scripts and docs to remove start errors (bash) and allow local serving add 82f2b50 Make current 2019 announcement page archived add 166f72e Add Announcement 2020-08-13 add d7a07ec Add $-syntax to announcement add 2b13f96 Adding documentation for FM and COOP/COEP (#1) add 18360c2 Remove individual interceptor refs add 85d7bbc Merge pull request #149 from salcho/fm-coop-coep-docs add 35c12fd Adds release info about Struts 2.5.25 add d9e8d07 Merge pull request #150 from apache/release-2525 new cfc948a Creates Contributors Guide starting page new ee45534 Drops WIP new 44312b5 Adds how to build new d9bd470 Adds Contributors Guide to the menu new 69a7edf Adding section how create a release new e45126d Uses the latest Maven summary new ee8f58b Adds One time steps page new de141f5 Adds Sample Announcements page new 160cb67 Converts new pages related to creating distro This update added new revisions after undoing existing revisions. That is to say, some revisions that were in the old version of the branch are not in the new version. This situation occurs when a user --force pushes a change and generates a repository containing something like this: * -- * -- B -- O -- O -- O (a5f1513) \ N -- N -- N refs/heads/contributors-guide (160cb67) You should already have received notification emails for all of the O revisions, and so the following emails describe only the N revisions from the common base, B. Any revisions marked "omit" are not gone; other references still refer to them. Any revisions marked "discard" are gone forever. The 9 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "add" were already present in the repository and have only been added to this reference. Summary of changes: _config.yml| 10 +++--- source/announce.md | 31 source/core-developers/coep-interceptor.md | 40 + source/core-developers/coop-interceptor.md | 42 ++ .../core-developers/fetch-metadata-interceptor.md | 39 source/core-developers/interceptors.md | 3 ++ source/index.html | 2 +- source/releases.html | 13 ++- source/security/index.md | 24 + 9 files changed, 197 insertions(+), 7 deletions(-) create mode 100644 source/core-developers/coep-interceptor.md create mode 100644 source/core-developers/coop-interceptor.md create mode 100644 source/core-developers/fetch-metadata-interceptor.md
[struts-site] 08/09: Adds Sample Announcements page
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git commit de141f509af377bfd0e376fb96d107eccd486d90 Author: Lukasz Lenart AuthorDate: Mon Aug 24 08:17:10 2020 +0200 Adds Sample Announcements page --- .../creating-and-signing-a-distribution.md | 2 +- source/contributors/sample-announcements.md| 196 + 2 files changed, 197 insertions(+), 1 deletion(-) diff --git a/source/contributors/creating-and-signing-a-distribution.md b/source/contributors/creating-and-signing-a-distribution.md index 2d6e11f..0957667 100644 --- a/source/contributors/creating-and-signing-a-distribution.md +++ b/source/contributors/creating-and-signing-a-distribution.md @@ -30,7 +30,7 @@ parent: Depends on what you want to achieve, please select topic from the list below: - [One time steps](one-time-steps) - before you start preparing a distribution -- [Sample announcements](#PAGE_27832957) - announcements used to communicate the achievement +- [Sample announcements](sample-announcements) - announcements used to communicate the achievement - [Building Struts Master](#PAGE_27839549) - how to release Struts Master - [Building Struts Annotations](#PAGE_27832965) - when you want to prepare a new distribution of Struts Annotations (if something changed) - [Building Struts 2 - Normal release](#PAGE_27832970) - the most common used path diff --git a/source/contributors/sample-announcements.md b/source/contributors/sample-announcements.md new file mode 100644 index 000..f8cf544 --- /dev/null +++ b/source/contributors/sample-announcements.md @@ -0,0 +1,196 @@ +--- +layout: default +title: Sample announcements +parent: + title: Contributors Guide + url: index.html +--- + +# Sample announcements +{:.no_toc} + +* Will be replaced with the ToC, excluding a header +{:toc} + +## Sample Struts Annotations Release/Quality Vote + +``` +Subject: [VOTE] Struts Annotations 1.0.x Vote +The Struts Annotations 1.0.x test build is now available as a Maven +artifact. It is a dependency of Struts 2.x.y. + +If you have had a chance to review the test build, please respond with +a vote on its quality: + +[ ] Leave at test build +[ ] Alpha +[ ] Beta +[ ] General Availability (GA) + +Everyone who has tested the build is invited to vote. Votes by PMC members are considered binding. A vote passes +if there are at least three binding +1s and more +1s than -1s. + +The vote will remain open for at least 72 hours, longer upon request. +``` + +## Sample Test Build Announcement + +> Test builds are only announced to the dev list. Announcements to the user list can only be made pursuant to a release +> vote with the consent of the PMC. + +``` +The test build of Struts 2.0.3 is available. + +No determination as to the quality ('alpha,' 'beta,' or 'GA') of Struts 2.0.3 has been made, and at this time it is +simply a "test build". We welcome any comments you may have, and will take all feedback into account if a quality vote +is called for this build. + +Release notes: +* [https://cwiki.apache.org/confluence/display/WW/Version+Notes+#.#.#] + +Distribution: +* [https://dist.apache.org/repos/dist/dev/struts/#.#.#/] + +Maven 2 staging repository: +* [https://repository.apache.org/content/groups/staging/] + +We appreciate the time and effort everyone has put toward contributing code and documentation, posting to the mailing +lists, and logging issues. +``` + +## Sample Release/Quality Vote + +``` +Subject: [VOTE] Struts #.#.# Vote +The Struts #.#.# test build is now available. + +Release notes: +* [https://cwiki.apache.org/confluence/display/WW/Version+Notes+#.#.#] + +Distribution: +* [https://dist.apache.org/repos/dist/dev/struts/#.#.#/] + +Maven 2 staging repository: +* [https://repository.apache.org/content/groups/staging/] + +Once you have had a chance to review the test build, please respond with a vote on its quality: + +[ ] Leave at test build +[ ] Alpha +[ ] Beta +[ ] General Availability (GA) + +Everyone who has tested the build is invited to vote. Votes by PMC members are considered binding. A vote passes if +there are at least three binding +1s and more +1s than -1s. + +The vote will remain open for at least 72 hours, longer upon request. A vote can be amended at any time to upgrade +or downgrade the quality of the release based on future experience. If an initial vote designates the build as "Beta", +the release will be submitted for mirroring and announced to the user list. Once released as a public beta, subsequent +quality votes on a build may be held on the user list. + +As always, the act of voting carries certain obligations. A binding vote not only states an opinion, but means that +the voter is agreeing to help do the work +``` + +## Sample Release Announcement + +``` +Subject: [ANN] Struts #.#.# [GA | Beta] release available + +The Apache
[struts-site] 01/09: Creates Contributors Guide starting page
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git commit cfc948a0f54f515fb830cfd5f965c46260843704 Author: Lukasz Lenart AuthorDate: Tue Jul 7 11:06:02 2020 +0200 Creates Contributors Guide starting page --- source/contributors/index.md | 43 +++ 1 file changed, 43 insertions(+) diff --git a/source/contributors/index.md b/source/contributors/index.md new file mode 100644 index 000..684622b --- /dev/null +++ b/source/contributors/index.md @@ -0,0 +1,43 @@ +--- +layout: default +title: Contributors Guide +--- + +# Contributors Guide + +## Source + +- [Building the Framework from Source](#PAGE_13829) + - [Building with Maven](#PAGE_14147) +- [Creating and Signing a Distribution](#PAGE_26375) +- [Requirements](#PAGE_29362) and [Use Cases](#PAGE_29364) - _under construction_ +- [Precise Error Reporting](#PAGE_29826) +- [Obtaining an IDEA license](#PAGE_29381) +- [How to Write Doc Comments for the Javadoc Tool](http://java.sun.com/j2se/javadoc/writingdoccomments/) (Sun) + +## Documentation + +- [Editing the Documentation](#PAGE_27087) +- [Documentation Colophon](#PAGE_13822) +- [Documentation Style Guide](#PAGE_14055) + +## Licensing and Copyright + +- [Third Party Licensing Policy RFC](http://people.apache.org/~cliffs/3party.html) +- [ASF Source Header and Copyright Notice Policy](http://www.apache.org/legal/src-headers.html) +- [Author Tags](http://tinyurl.com/mw7t6)^[http://tinyurl.com/mw7t6] + +## Quick Links + +- [How to Help FAQ](../../helping) +- [Project Charter](../../bylaws) +- [Volunteers](../../volunteers) +- [Release Guidelines](../../releases) +- [Javadocs](http://people.apache.org/~mrdon/action2-api/) +- [Source code repository](https://svn.apache.org/repos/asf/struts/action2) +- [Our WebWork roots](http://today.java.net/pub/a//today/2005/02/25/opensymphony.html) + +## Bleeding Edge + +- [Struts 2.0.2 Release Plan](http://wiki.apache.org/struts/StrutsActionRelease202) +- [Struts Ti Proposal](http://wiki.apache.org/struts/StrutsTi)
[struts-site] 05/09: Adding section how create a release
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git commit 69a7edf08e55b7656b4a47d6c5a088f4e27bfefb Author: Lukasz Lenart AuthorDate: Mon Jul 20 08:59:20 2020 +0200 Adding section how create a release --- .../creating-and-signing-a-distribution.md | 37 ++ source/contributors/index.md | 4 +-- 2 files changed, 39 insertions(+), 2 deletions(-) diff --git a/source/contributors/creating-and-signing-a-distribution.md b/source/contributors/creating-and-signing-a-distribution.md new file mode 100644 index 000..372c003 --- /dev/null +++ b/source/contributors/creating-and-signing-a-distribution.md @@ -0,0 +1,37 @@ +--- +layout: default +title: Creating and Signing a Distribution +parent: + title: Contributors Guide + url: index.html +--- + +#Creating and Signing a Distribution +{:.no_toc} + +* Will be replaced with the ToC, excluding a header +{:toc} + +## How to prepare a normal release ? + +- create a Version Notes page and start adding important changes to it +- create a filter in JIRA with `Fix Version` pointing to the release version you want to prepare +- review JIRA issues and re-organise them, move the `Fix Version` to the next release or `Future`, mark what should be + solved in the release you're working on + +## How to prepare a fast track release ? + +- keep all the information confidential as possible, communicate throughout security@struts.a.o group +- restrict access to all the related pages created in Confluence to struts-committers group only, they can be made + public available after a fix or workaround has been released + +## What do you want to build ? + +Depends on what you want to achieve, please select topic from the list below: + +- [One time steps](#PAGE_27832952) - before you start preparing a distribution +- [Sample announcements](#PAGE_27832957) - announcements used to communicate the achievement +- [Building Struts Master](#PAGE_27839549) - how to release Struts Master +- [Building Struts Annotations](#PAGE_27832965) - when you want to prepare a new distribution of Struts Annotations (if something changed) +- [Building Struts 2 - Normal release](#PAGE_27832970) - the most common used path +- [Building Struts 2 - Fast track release](#PAGE_27834014) - how to prepare a fast track release with important security patch diff --git a/source/contributors/index.md b/source/contributors/index.md index 684622b..4cad522 100644 --- a/source/contributors/index.md +++ b/source/contributors/index.md @@ -7,8 +7,8 @@ title: Contributors Guide ## Source -- [Building the Framework from Source](#PAGE_13829) - - [Building with Maven](#PAGE_14147) +- [Building the Framework from Source](building-the-framework-from-source) + - [Building with Maven](building-with-maven) - [Creating and Signing a Distribution](#PAGE_26375) - [Requirements](#PAGE_29362) and [Use Cases](#PAGE_29364) - _under construction_ - [Precise Error Reporting](#PAGE_29826)
[struts-site] 03/09: Adds how to build
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git commit 44312b5d5c9f925d8e19a85e3b4913717868dddb Author: Lukasz Lenart AuthorDate: Tue Jul 7 11:35:59 2020 +0200 Adds how to build --- .../building-the-framework-from-source.md | 70 +++ source/contributors/building-with-maven.md | 206 + 2 files changed, 276 insertions(+) diff --git a/source/contributors/building-the-framework-from-source.md b/source/contributors/building-the-framework-from-source.md new file mode 100644 index 000..0f1fe95 --- /dev/null +++ b/source/contributors/building-the-framework-from-source.md @@ -0,0 +1,70 @@ +--- +layout: default +title: Building the Framework from Source +parent: +title: Contributors Guide +url: index.html +--- + +# Building the Framework from Source +{:.no_toc} + +* Will be replaced with the ToC, excluding a header +{:toc} + +## Why Build? + +Most developers will never need to build the framework from source. The distribution package contains everything +a developer needs to get started and become productive with the framework. For more on how to go to work with +the distributed binaries right away, see _Ready, Set, Go\!_ . However, there are situations when someone will want +to build the framework from scratch. You may want to try out new tweaks and patches, or you might want to try writing +your own tweak or patch. + +> If you just want to use the latest development build, perhaps because a patch you need has been applied, you can +> also [download a nightly build](http://ci.apache.org/projects/struts/nightlies/). + +## Getting the Sources + +The source code for the framework is available as a distribution you can download directly and from the source code repository. + +## Distribution + +The distributions of the framework contain all sources, as well as all needed libraries for building JARs and running. +Distributions can be downloaded from the [Apache Struts project](../../downloads) + +## Repository (Git) + +Use [Git](https://git-scm.com/) to checkout the source code. + +``` +> cd Projects\Apache\ +> git clone https://gitbox.apache.org/repos/asf/struts.git +``` + +## Building with Maven + +The default build environment is Maven. You can either install Maven 3 or use Maven Wrapper delivered with the source code. +Change to your framework home directory: + +``` +cd Projects\Apache\struts +``` + +and run Maven + +``` +mvn clean install +``` + +or run using Maven Wrapper + +``` +./mvnw clean install +``` + +That will take care of the basic maven build. There is a bunch more that you can do. Checkout out [Building with Maven](building-with-maven) +for more information. + +## JDK/JRE Compatibility + +The framework requires JDK 1.8 to build. diff --git a/source/contributors/building-with-maven.md b/source/contributors/building-with-maven.md new file mode 100644 index 000..4c76bc4 --- /dev/null +++ b/source/contributors/building-with-maven.md @@ -0,0 +1,206 @@ +--- +layout: default +title: Building with Maven +parent: + title: Contributors Guide + url: index.html +--- + +# Building with Maven +{:.no_toc} + +* Will be replaced with the ToC, excluding a header +{:toc} + +[Maven 3.0.0 or later](http://maven.apache.org) is required to build Struts 2 + +First, let's review some Maven basics. Maven uses the notion of a build _life-cycle_ to which plugins can attach. +Plugins are similar to Ant tasks. When a Maven build is invoked, we specify a point in the life-cycle up to which +the build _should_ proceed. The _compile_ phase comes before _test_ , and _test_ comes before _package_ , and _package_ +comes before _install_ . Once we have Maven setup, we can invoke the Struts build, and specify which phase the build should use. + +## Installing + +The _install_ phase builds up the project ("package"), and installs any JARs it needs into your local repository, e.g.: + +``` +~/.m2/repository +``` + +Once installed, the JARs can be used by any other Maven project you build. The _install_ phase is the **default** phase +if none is specified. + +To run a basic install, change to the root of the source distribution, and enter + +``` +mvn +``` + +That's it! Maven will download any dependencies the build needs; run all unit tests; package up the JARs; then install th +e new JARs locally. For your convenience, copies of the JARs can be found in the _target_ directories of each module. +For example, after the build, the main JAR can found at + +``` +core/target/struts2-core-2.0-SNAPSHOT.jar +``` + +> Sometimes, licensing restrictions prevent Maven from downloading all the JARs that a build might need. For example, +> JavaMail and Activation, can only be downloaded from Sun. When this happens, Maven will display a helpful message +> that explains how to install these JARs manually. A
[struts-site] branch contributors-guide updated: Uses proper back navigation
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git The following commit(s) were added to refs/heads/contributors-guide by this push: new b23d4e1 Uses proper back navigation b23d4e1 is described below commit b23d4e1987599f4070a1b0eb10cd90ee6393f4dd Author: Lukasz Lenart AuthorDate: Tue Sep 29 10:16:20 2020 +0200 Uses proper back navigation --- source/contributors/building-struts-master.md | 4 ++-- source/contributors/creating-and-signing-a-distribution.md | 2 +- source/contributors/one-time-steps.md | 4 ++-- source/contributors/sample-announcements.md| 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/source/contributors/building-struts-master.md b/source/contributors/building-struts-master.md index d1a60f9..fcf4548 100644 --- a/source/contributors/building-struts-master.md +++ b/source/contributors/building-struts-master.md @@ -2,8 +2,8 @@ layout: default title: Building Struts Master parent: - title: Contributors Guide - url: index.html + title: Creating and Signing a Distribution + url: creating-and-signing-a-distribution --- # Building Struts Master diff --git a/source/contributors/creating-and-signing-a-distribution.md b/source/contributors/creating-and-signing-a-distribution.md index a50d744..b315592 100644 --- a/source/contributors/creating-and-signing-a-distribution.md +++ b/source/contributors/creating-and-signing-a-distribution.md @@ -6,7 +6,7 @@ parent: url: index.html --- -#Creating and Signing a Distribution +# Creating and Signing a Distribution {:.no_toc} * Will be replaced with the ToC, excluding a header diff --git a/source/contributors/one-time-steps.md b/source/contributors/one-time-steps.md index efb55b1..ce06b4c 100644 --- a/source/contributors/one-time-steps.md +++ b/source/contributors/one-time-steps.md @@ -2,8 +2,8 @@ layout: default title: One time steps parent: - title: Contributors Guide - url: index.html + title: Creating and Signing a Distribution + url: creating-and-signing-a-distribution --- # One time steps diff --git a/source/contributors/sample-announcements.md b/source/contributors/sample-announcements.md index f8cf544..8c8511a 100644 --- a/source/contributors/sample-announcements.md +++ b/source/contributors/sample-announcements.md @@ -2,8 +2,8 @@ layout: default title: Sample announcements parent: - title: Contributors Guide - url: index.html + title: Creating and Signing a Distribution + url: creating-and-signing-a-distribution --- # Sample announcements
[struts-site] branch asf-staging updated: Updates stage by Jenkins
This is an automated email from the ASF dual-hosted git repository. git-site-role pushed a commit to branch asf-staging in repository https://gitbox.apache.org/repos/asf/struts-site.git The following commit(s) were added to refs/heads/asf-staging by this push: new 16fc271 Updates stage by Jenkins 16fc271 is described below commit 16fc271b11d4c112849c55155e88d825f6d160df Author: jenkins AuthorDate: Tue Sep 29 08:21:08 2020 + Updates stage by Jenkins --- content/contributors/building-struts-master.html | 2 +- content/contributors/creating-and-signing-a-distribution.html | 2 +- content/contributors/one-time-steps.html | 2 +- content/contributors/sample-announcements.html| 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/contributors/building-struts-master.html b/content/contributors/building-struts-master.html index 12ff43b..56fff2c 100644 --- a/content/contributors/building-struts-master.html +++ b/content/contributors/building-struts-master.html @@ -129,7 +129,7 @@ https://github.com/apache/struts-site/edit/master/source/contributors/building-struts-master.md"; title="Edit this page on GitHub">Edit on GitHub -<< back to Contributors Guide +<< back to Creating and Signing a Distribution Building Struts Master diff --git a/content/contributors/creating-and-signing-a-distribution.html b/content/contributors/creating-and-signing-a-distribution.html index f704a0c..c7acf69 100644 --- a/content/contributors/creating-and-signing-a-distribution.html +++ b/content/contributors/creating-and-signing-a-distribution.html @@ -131,7 +131,7 @@ << back to Contributors Guide -#Creating and Signing a Distribution +Creating and Signing a Distribution How to prepare a normal release ? diff --git a/content/contributors/one-time-steps.html b/content/contributors/one-time-steps.html index 9bc9c8b..a7b363b 100644 --- a/content/contributors/one-time-steps.html +++ b/content/contributors/one-time-steps.html @@ -129,7 +129,7 @@ https://github.com/apache/struts-site/edit/master/source/contributors/one-time-steps.md"; title="Edit this page on GitHub">Edit on GitHub -<< back to Contributors Guide +<< back to Creating and Signing a Distribution One time steps diff --git a/content/contributors/sample-announcements.html b/content/contributors/sample-announcements.html index 96ab99a..ccd212e 100644 --- a/content/contributors/sample-announcements.html +++ b/content/contributors/sample-announcements.html @@ -129,7 +129,7 @@ https://github.com/apache/struts-site/edit/master/source/contributors/sample-announcements.md"; title="Edit this page on GitHub">Edit on GitHub -<< back to Contributors Guide +<< back to Creating and Signing a Distribution Sample announcements
[struts-site] branch contributors-guide updated: Converts release guidelines
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git The following commit(s) were added to refs/heads/contributors-guide by this push: new 6d15e7c Converts release guidelines 6d15e7c is described below commit 6d15e7cf7cf904f3cb334a910b72120e030e8dd2 Author: Lukasz Lenart AuthorDate: Wed Sep 30 08:19:23 2020 +0200 Converts release guidelines --- source/contributors/building-fast-track-release.md | 49 + source/contributors/building-normal-release.md | 229 + source/contributors/building-struts-annotations.md | 46 + .../creating-and-signing-a-distribution.md | 6 +- source/updating-website.md | 6 +- 5 files changed, 330 insertions(+), 6 deletions(-) diff --git a/source/contributors/building-fast-track-release.md b/source/contributors/building-fast-track-release.md new file mode 100644 index 000..8560410 --- /dev/null +++ b/source/contributors/building-fast-track-release.md @@ -0,0 +1,49 @@ +--- +layout: default +title: Building Fast Track Release +parent: + title: Creating and Signing a Distribution + url: creating-and-signing-a-distribution +--- + +# Building fast track release +{:.no_toc} + +* Will be replaced with the ToC, excluding a header +{:toc} + +## Getting ready + +Follow the same steps as for [Normal Release](building-normal-release) + +Please be aware you should create a new Security Bulletin in secret, you should assign only `struts-committers` group +to be visible for. If the release will fix a - hopefully yet undisclosed - security issue, you must update +the [Security Bulletins](https://cwiki.apache.org/confluence/display/WW/Security+Bulletins) page. It also needs to be +accessible only by members of the `struts-committers` group. + +## Apply security patch + +Apply and commit security patch. + +## Next steps + +Follow the same steps as for [Normal Release](building-normal-release) + +- Prepare release +- Perform the release +- Jira stuff +- Vote on it + Post a release/quality vote to the dev list (and **only** the dev list). The example mail is on [Sample announcements](sample-announcements) + page. Include the term "fast-track" in the subject, as: [VOTE] Struts 2.0.9.1 quality (fast track). + Please be aware this vote should be open only 24h! +- Copy files +- Promote release +- Clean up old releases +- Wait for rsync +- Update site +- Post announcements + Announce the release and the vulnerability. Typically, this will be sent to the reporter, the project's users list + (user@struts.a.o), the project's dev list (dev@struts.a.o), the project's announce list (announcements@struts.a.o), + secur...@apache.org, full-disclos...@lists.grok.org.uk and bugt...@securityfocus.com. + Samples are available at [Sample announcements](sample-announcements) page. + diff --git a/source/contributors/building-normal-release.md b/source/contributors/building-normal-release.md new file mode 100644 index 000..c154b18 --- /dev/null +++ b/source/contributors/building-normal-release.md @@ -0,0 +1,229 @@ +--- +layout: default +title: Building Normal Release +parent: + title: Creating and Signing a Distribution + url: creating-and-signing-a-distribution +--- + +# Building Normal Release +{:.no_toc} + +* Will be replaced with the ToC, excluding a header +{:toc} + +## Getting ready + +1. Ensure that the master POM and Struts Annotations have current releases +2. Review JIRA for any issues without a fix version set, and for any issues that should be resolved for the pending release. +3. Ensure that there are no `repositories` or `pluginRepositories` listed in the poms. +4. Release the upcoming version in JIRA (under Administration/Manage Releases) and tag the release date +5. Add next milestone version to the JIRA roadmap +6. Create DONE and TODO filters for the new version, share with all, and remove obsolete TODO filter +7. Create a new Version Notes page in Confluence, link from [Migration Guide](https://cwiki.apache.org/confluence/display/WW/Migration+Guide), + and link to prior release page and JIRA DONE filters of the version to release + +> Please remember to keep BOM subproject in sync - X.X.X - must be +> the same as the parent pom. The latest Maven version handles this case very well, but it's worth checking if the bits +> are in sync. + +> If needed, you can use [Versions Maven Plugin](http://mojo.codehaus.org/versions-maven-plugin/) to set -SNAPSHOT version +> in all poms, like below: +> `mvn versions:set -DnewVersion=2.3.16.1-SNAPSHOT -DgenerateBackupPoms=false` + +## Prepare release + +Tag the release by using the "release:prepare" goal of Maven: + +``` +mvn release:prepare -DautoVersionSubmodules=true +``` + +For a [dry run](http://maven.apache.org/plugins/maven-release-plugin/usage.html), add `-DdryRun=true`. If you do a dry +ru
[struts-site] branch asf-staging updated: Updates stage by Jenkins
This is an automated email from the ASF dual-hosted git repository. git-site-role pushed a commit to branch asf-staging in repository https://gitbox.apache.org/repos/asf/struts-site.git The following commit(s) were added to refs/heads/asf-staging by this push: new 71bc0ab Updates stage by Jenkins 71bc0ab is described below commit 71bc0ab722cc4711ddb5b42cbb08ca1a6f0d373d Author: jenkins AuthorDate: Wed Sep 30 06:24:50 2020 + Updates stage by Jenkins --- ...ution.html => building-fast-track-release.html} | 64 ++-- content/contributors/building-normal-release.html | 423 + ...ution.html => building-struts-annotations.html} | 62 +-- .../creating-and-signing-a-distribution.html | 6 +- content/updating-website.html | 6 +- 5 files changed, 497 insertions(+), 64 deletions(-) diff --git a/content/contributors/creating-and-signing-a-distribution.html b/content/contributors/building-fast-track-release.html similarity index 75% copy from content/contributors/creating-and-signing-a-distribution.html copy to content/contributors/building-fast-track-release.html index c7acf69..ada182e 100644 --- a/content/contributors/creating-and-signing-a-distribution.html +++ b/content/contributors/building-fast-track-release.html @@ -7,7 +7,7 @@ - Creating and Signing a Distribution + Building Fast Track Release @@ -127,48 +127,56 @@ -https://github.com/apache/struts-site/edit/master/source/contributors/creating-and-signing-a-distribution.md"; title="Edit this page on GitHub">Edit on GitHub +https://github.com/apache/struts-site/edit/master/source/contributors/building-fast-track-release.md"; title="Edit this page on GitHub">Edit on GitHub -<< back to Contributors Guide +<< back to Creating and Signing a Distribution -Creating and Signing a Distribution +Building fast track release - How to prepare a normal release ? - How to prepare a fast track release ? - What do you want to build ? + Getting ready + Apply security patch + Next steps -How to prepare a normal release ? +Getting ready - - create a Version Notes page and start adding important changes to it - create a filter in JIRA with Fix Version pointing to the release version you want to prepare - review JIRA issues and re-organise them, move the Fix Version to the next release or Future, mark what should be -solved in the release you’re working on - +Follow the same steps as for Normal Release -How to prepare a fast track release ? +Please be aware you should create a new Security Bulletin in secret, you should assign only struts-committers group +to be visible for. If the release will fix a - hopefully yet undisclosed - security issue, you must update +the https://cwiki.apache.org/confluence/display/WW/Security+Bulletins";>Security Bulletins page. It also needs to be +accessible only by members of the struts-committers group. - - keep all the information confidential as possible, communicate throughout security@struts.a.o group - restrict access to all the related pages created in Confluence to struts-committers group only, they can be made -public available after a fix or workaround has been released - +Apply security patch + +Apply and commit security patch. -What do you want to build ? +Next steps -Depends on what you want to achieve, please select topic from the list below: +Follow the same steps as for Normal Release - One time steps - before you start preparing a distribution - Sample announcements - announcements used to communicate the achievement - Building Struts Master - how to release Struts Master - Building Struts Annotations - when you want to prepare a new distribution of Struts Annotations (if something changed) - Building Struts 2 - Normal release - the most common used path - Building Struts 2 - Fast track release - how to prepare a fast track release with important security patch + Prepare release + Perform the release + Jira stuff + Vote on it +Post a release/quality vote to the dev list (and only the dev list). The example mail is on Sample announcements +page. Include the term “fast-track” in the subject, as: [VOTE] Struts 2.0.9.1 quality (fast track). +Please be aware this vote should be open only 24h! + Copy files + Promote release + Clean up old releases + Wait for rsync + Update site + Post announcements +Announce the release and the vulnerability. Typically, this will be sent to the reporter, the project’s users list +(user@struts.a.o), the project’s dev list (dev@struts.a.o), the project’s announce list (announcements@struts.a.o), +secur...@apache.org, full-disclos...@lists.grok.org.uk and bugt...@securityfocus.com. +Samples are available at Sample announcements page. + diff --git a/content/contributors/building-normal-release.html b/content/contributors/building-normal-release.html new file mode 100644
[struts-site] branch contributors-guide updated: Small updates
This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch contributors-guide in repository https://gitbox.apache.org/repos/asf/struts-site.git The following commit(s) were added to refs/heads/contributors-guide by this push: new 8b060ad Small updates 8b060ad is described below commit 8b060adc2b2eb4d9ff1916d8cf4266168ea1db65 Author: Lukasz Lenart AuthorDate: Wed Sep 30 08:43:25 2020 +0200 Small updates --- source/contributors/building-fast-track-release.md | 15 +++ source/contributors/index.md | 4 ++-- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/source/contributors/building-fast-track-release.md b/source/contributors/building-fast-track-release.md index 8560410..7983c9d 100644 --- a/source/contributors/building-fast-track-release.md +++ b/source/contributors/building-fast-track-release.md @@ -33,17 +33,16 @@ Follow the same steps as for [Normal Release](building-normal-release) - Perform the release - Jira stuff - Vote on it - Post a release/quality vote to the dev list (and **only** the dev list). The example mail is on [Sample announcements](sample-announcements) - page. Include the term "fast-track" in the subject, as: [VOTE] Struts 2.0.9.1 quality (fast track). - Please be aware this vote should be open only 24h! + - Post a release/quality vote to the dev list (and **only** the dev list). The example mail is on [Sample announcements](sample-announcements) +page. Include the term "fast-track" in the subject, as: [VOTE] Struts 2.0.9.1 quality (fast track). +Please be aware this vote should be open only 24h! - Copy files - Promote release - Clean up old releases - Wait for rsync - Update site - Post announcements - Announce the release and the vulnerability. Typically, this will be sent to the reporter, the project's users list - (user@struts.a.o), the project's dev list (dev@struts.a.o), the project's announce list (announcements@struts.a.o), - secur...@apache.org, full-disclos...@lists.grok.org.uk and bugt...@securityfocus.com. - Samples are available at [Sample announcements](sample-announcements) page. - + - Announce the release and the vulnerability. Typically, this will be sent to the reporter, the project's users list +(user@struts.a.o), the project's dev list (dev@struts.a.o), the project's announce list (announcements@struts.a.o), +secur...@apache.org, full-disclos...@lists.grok.org.uk and bugt...@securityfocus.com. +Samples are available at [Sample announcements](sample-announcements) page. diff --git a/source/contributors/index.md b/source/contributors/index.md index 049602d..317615a 100644 --- a/source/contributors/index.md +++ b/source/contributors/index.md @@ -12,7 +12,7 @@ title: Contributors Guide - [Creating and Signing a Distribution](creating-and-signing-a-distribution) - [Precise Error Reporting](precise-error-reporting) - [Obtaining an IDEA license](obtaining-an-idea-license) -- [How to Write Doc Comments for the Javadoc Tool](http://java.sun.com/j2se/javadoc/writingdoccomments/) (Sun) +- [How to Write Doc Comments for the Javadoc Tool](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html) (Oracle) ## Documentation @@ -24,7 +24,7 @@ title: Contributors Guide - [Third Party Licensing Policy RFC](http://people.apache.org/~cliffs/3party.html) - [ASF Source Header and Copyright Notice Policy](http://www.apache.org/legal/src-headers.html) -- [Author Tags](http://tinyurl.com/mw7t6)^[http://tinyurl.com/mw7t6] +- [Author Tags](http://tinyurl.com/mw7t6) ## Quick Links
[struts-site] branch asf-staging updated: Updates stage by Jenkins
This is an automated email from the ASF dual-hosted git repository. git-site-role pushed a commit to branch asf-staging in repository https://gitbox.apache.org/repos/asf/struts-site.git The following commit(s) were added to refs/heads/asf-staging by this push: new ac4e7d0 Updates stage by Jenkins ac4e7d0 is described below commit ac4e7d0204e3cd1f247eb99ce2c4e96ca6bf1a03 Author: jenkins AuthorDate: Wed Sep 30 06:44:48 2020 + Updates stage by Jenkins --- content/contributors/building-fast-track-release.html | 11 --- content/contributors/index.html | 4 ++-- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/content/contributors/building-fast-track-release.html b/content/contributors/building-fast-track-release.html index ada182e..1f08e64 100644 --- a/content/contributors/building-fast-track-release.html +++ b/content/contributors/building-fast-track-release.html @@ -161,22 +161,27 @@ accessible only by members of the struts-committ Perform the release Jira stuff Vote on it -Post a release/quality vote to the dev list (and only the dev list). The example mail is on Sample announcements + + Post a release/quality vote to the dev list (and only the dev list). The example mail is on Sample announcements page. Include the term “fast-track” in the subject, as: [VOTE] Struts 2.0.9.1 quality (fast track). Please be aware this vote should be open only 24h! + + Copy files Promote release Clean up old releases Wait for rsync Update site Post announcements -Announce the release and the vulnerability. Typically, this will be sent to the reporter, the project’s users list + + Announce the release and the vulnerability. Typically, this will be sent to the reporter, the project’s users list (user@struts.a.o), the project’s dev list (dev@struts.a.o), the project’s announce list (announcements@struts.a.o), secur...@apache.org, full-disclos...@lists.grok.org.uk and bugt...@securityfocus.com. Samples are available at Sample announcements page. + + - diff --git a/content/contributors/index.html b/content/contributors/index.html index 0ecc58b..2c4db64 100644 --- a/content/contributors/index.html +++ b/content/contributors/index.html @@ -142,7 +142,7 @@ Creating and Signing a Distribution Precise Error Reporting Obtaining an IDEA license - http://java.sun.com/j2se/javadoc/writingdoccomments/";>How to Write Doc Comments for the Javadoc Tool (Sun) + https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html";>How to Write Doc Comments for the Javadoc Tool (Oracle) Documentation @@ -158,7 +158,7 @@ http://people.apache.org/~cliffs/3party.html";>Third Party Licensing Policy RFC http://www.apache.org/legal/src-headers.html";>ASF Source Header and Copyright Notice Policy - http://tinyurl.com/mw7t6";>Author Tags^[http://tinyurl.com/mw7t6] + http://tinyurl.com/mw7t6";>Author Tags Quick Links