http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/misc/PossibleContributions.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/misc/PossibleContributions.adoc b/docs/src/main/asciidoc/misc/PossibleContributions.adoc deleted file mode 100644 index 9a6c78d..0000000 --- a/docs/src/main/asciidoc/misc/PossibleContributions.adoc +++ /dev/null @@ -1,315 +0,0 @@ -Apache Tamaya - Possible Tasks -============================== -:name: Tamaya -:rootpackage: org.apache.tamaya -:title: Apache Tamaya -:revnumber: 0.1-SNAPSHOT -:revremark: Draft -:revdate: October 2014 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <atsti...@gmail.com> -:source-highlighter: coderay -:website: http://tamaya.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - --> add image : : https://raw.githubusercontent.com/JavaConfig/config-api/master/src/main/asciidoc/images/javaconfig.jpg[] - -toc::[] - -<<< -:numbered!: ------------------------------------------------------------ -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. ------------------------------------------------------------ - -:numbered: - -<<< - -== Introduction - -== What is Tamaya - -{name} is the Apache standard for flexible and powerful configuration. Objective is to provide flavors for -Java SE, ME as well as to ship with powerful features for Java EE and Cloud Solutions. All functions provided -is build on top of a small but very powerful, flexible and extendible API. This API is implemented by a core implementation, -which then can be extended or adapted for use in different runtime scenarios, such as SE, ME, EE, Spring, OSGI -and more. Similarly additional modules may be provided that help also existing solution to be plugged into -{name}, so you can start right away using {name} without having to rebuild/change your existing application. - - -=== Purpose of this Document - -The document should help to organize people and ideas around the Apache Tamaya Library. It list possible features, -ideas and tasks that need to be done. Everybody can have a look at and see, where hos contribution and capabilities -would fit best. - - -== Main Features - -=== Metadata Model - -Currently +MetaInfo+ models metadata as a separate constuct. It has been shown that this leads to more complex -handling when creating composites and makes the API overall more complex. The idea is to model metadata as simple -key/value pairs, that are part of the provider/configuration data as well, but handled separately. Metadata hereby -is identified by a starting '_' character in its key. For example refer to the following configuration properties: - -[source,listing] -.Basic Properties ----------------------------------------------------------------- -a.b.Foo=foo -a.b.Bar=bar -a.AnyOther=whatelse -Something=none ----------------------------------------------------------------- - -Now we can model meta-data as follows: - -[source,listing] -.Metadata Properties ----------------------------------------------------------------- -[a.b].info=An area info -[a.b.Foo].auth=role1,role2 -[a.b.Foo].encrypt=PGP -[a.b.Foo].sensitive=true -[].info=This is a test configuration example. ----------------------------------------------------------------- - -The above would model the following: - -* The area +a.b+ has the meta property +info+. -* The entry +a.b.Foo+ has three meta properties +auth,encrypt+ and +sensitive+. These could be interpreted by a security - view and used to encrypt the values returned by the configuration instance, if not the current user has one of the - specified roles. -* The last meta data defines an attribute +info+ for the whole provider/configuration (the root area). - -Given that the overall entries would be as follows: - -[source,listing] -.Full Properties with Meta Properties ----------------------------------------------------------------- -[a.b].info=An area info -a.b.Foo=foo -[a.b.Foo].auth=role1,role2 -[a.b.Foo].encrypt=PGP -[a.b.Foo].sensitive=true -a.b.Bar=bar -[].info=This is a test configuration example. -a.AnyOther=whatelse -Something=none ----------------------------------------------------------------- - -The current +MetaInfo+ class could be adapted, so it is reading data from the underlying configuration/provider, -instead of its own datastructure. This would make a later mapping of configuration and its metadata into DB table, JSON -etc, much more easier. -The providers on the other side may suppress any metadata from ordinary output, such -as +toString()+, Similarly accessing metadata using the official config API (+get, getOrDefault, getAreas+ etc) -should be disabled. The +MetaInfoBuilder+ must probably as well adapted or redesigned. - -=== Collection Support - -Add a key/value based model for mapping collections such as sets, maps, list. Implement according adapters. -In combination with the metadata model above this could be something like: - -[source,listing] -.Collection Support ----------------------------------------------------------------- -mySet=[a,b,c,d,e\,e,f] -[mySet].type=set -#optional define the implementation class -[mySet].class=java.util.TreeSet - -myList=[a,b,c,d,e\,e,f] -[myList].type=list -#optional define the implementation class -[myList].class=java.util.ArrayList - -myMap=[a:aa,b:bb,c:cc,d:dd,e:e\,e,f:ff] -[myMap].type=map -#optional define the implementation class -[myMap].class=java.util.TreeMap - -#Finally we could also add support for non String based types -myTypedSet=[1,2,3,4.5,6,7.10.123] -[myTypedSet].contentClass=java.lang.Double -myTypedList=[CHF 10.20, EUR 12.20, BTC 0.002] -[myTypedList].contentType=org.javamoney.moneta.FastMoney -myTypedMap=[CHF:CHF 10.20, EUR:EUR 12.20, BTC:BTC 0.002] -[myTypedMap].contentTypes=javax.money.CurrencyUnit,javax.money.MonetaryAmount ----------------------------------------------------------------- - - -=== Management Client - -A nice web-based client to manage configuration data would be nice as well. This also includes a UI for creating new -configurations. - -=== Mapping Configuration to a Database - -A flexible mechanism should be implemented that allows the use of databases (SQL/JPA as well as non-SQL) for -storing/retreiving/managing configuration: - -* JPA, Hibernate -* MongoDB -* ... - - -=== Integration with OSGI - -Examples are to be created and tested, where OSGI is used as the basic runtime platform, e.g. Apache Felix, but as well -others. - -=== Integration with Jigsaw - -Once Jigsaw is mature and in a usable (still early) stage, examples are to be created and tested, where OSGI is used as -the basic runtime platform, e.g. Apache Felix, but as well others. - -== Distributed/Remote Configuration Support - -=== Configuration Server - -A configuration server should be implemented that provides access to configurations and triggers updates to registered -clients (push). Similarly a poull model should be supported, where clients can asl for the current version id of a certain -configuration and reload it if necessary. - - -=== Configuration Distribution Policies - -Different configuration distribution policies should be defined any implemented, e.g. distributed cache, restful services, -web services, EJB/RMI calls, asynchronous queues, publish/subsribe models, ... - - -=== Configuration Client - -A subset of the API would be created that exposes only a well defined subset, of exactly one configuration targeted -to a certain instance, VM or whatever. The client should be connectable to a server in different ways (see configuration -distributiont policies). - - -=== Preferences Support - -Write a +PreferencesFactory+ for +java.util.preferences+. - - -== Third Party Integration - -=== Integration with Deltaspike Config - -Integration with Deltaspike Config should be implemented and discussed with Deltaspike guys. - -=== Integration with Spring - -A {name} module should be created that allows Spring to be used either as client or configuration provider. - -=== Integration with Jetty - -A {name} module should be created that allows a Jetty instance to be deployed and started that is (completely) -configured based on configuration server. - -=== Integration with Tomcat - -A {name} module should be created that allows a Tomcat instance to be deployed and started that is (completely) -configured based on configuration server. - -=== Configuration of Java EE - -In the Java EE area there would be several options: - -=== Configuration of Application Servers (administrative resources) - -It should be possible to start a application server instance remotely and configure all administrative resources and the -deployments based on the configuration service, server to be considered maybe - -* Wildfly -* IBM -* Weblogic -* Glassfish -* Apache Geronimo - -==== Configuration of Bean Validation - -* Add configurable validators. -* Configure bean validation based on configuration -* ... - -=== JNDI Support - -Write a +JCA+ adapter to provide configuration data through JNDI. - -==== Configure JSF - -Use the JSF +XML Document+ event to completely configure JSF. - -==== Configure Web Services - -Provide a WebServiceProviderFactory that may be configured. - -==== Configure JPA - -Provide an implementation that allows configuration of persistence units. Talk with JPA EG people to see if we can -get an SPI to hook in a stadardized way. - -==== Configure EJBs - -Provide an implementation that allows configuration of EJBs and MDBs: - -* Register beans -* Unregister/disable beans -* Intercept beans -* Support Configuration Injection (in the worst case using a standard Interceptor, provide supporting artifacts to - help developers to achive this easily). -* Talk with EE8 Umbrella EG (Bill Shanon, Linda DeMichels) on a feasible SPI for EE8, if possible join the EG. - -==== Configure ... - -Just think of any Java EE aspects that might be worth to be configured. If it can be done, e.g. by managing CDI managed -resources, it might be easy. For others it is a good idea to discuss things with our matter of experts... - -== Special Goodies - -=== Maintenance Mode Servlet Filter - -Provide a servlet filter that is capable of switching to maintenance mode, based on configuration. Similarly also a forwarding -servlet could be useful, wehere only request based on configuration are forwarded, other might be rejected or dropped -as configured. - -=== Dynamic Camel Routes - -Provides dynamic (configurable) Camel routes, e.g. usable within ServiceMix or standalone. - -=== Dynamic CXF - -Provides dynamic (configurable) CXF adapters, e.g. usable within ServiceMix or standalone. - -=== Configurable Apache MQ - -Provides an implementation for configuring Apache MQ. - -=== Dynamic ... - -Interested to see what other ideas are around. Let us know! -
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/misc/examples.adoc.nonfunc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/misc/examples.adoc.nonfunc b/docs/src/main/asciidoc/misc/examples.adoc.nonfunc deleted file mode 100644 index 0fca744..0000000 --- a/docs/src/main/asciidoc/misc/examples.adoc.nonfunc +++ /dev/null @@ -1,91 +0,0 @@ -= Tamayas Asciidoctor Example Document -Oliver B. Fischer -// 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. -:encoding: UTF-8 -:source-highlighter: coderay - -This document is used to see if the current setup -of Asciidoctor within the Tamaya project is working -correctly. Therefore it contains some sections -with different examples of Asciidoctors capabilities. - -== Asciidoctor Environment - -Some facts on the current Asciidoctor environment. - -Asciidoctor version:: {asciidoctor-version} - - -== Plant UML - -This chapter contains a -http://plantuml.sourceforge.net/[Plant UML] diagram. - - -[plantuml, diagram-classes, png] -.... -class BlockProcessor -class DiagramBlock -class DitaaBlock -class PlantUmlBlock - -BlockProcessor <|-- DiagramBlock -DiagramBlock <|-- DitaaBlock -DiagramBlock <|-- PlantUmlBlock -.... - - -== Ditaa - -This section contains a diagram from -http://asciidoctor.org/docs/asciidoctor-diagram/[Asciidoctor Diagram website] -generated with http://ditaa.sourceforge.net/[ditaa]. - -[ditaa, "asciidoctor-diagram-process"] -.... - +-------------+ - | Asciidoctor |-------+ - | diagram | | - +-------------+ | PNG out - ^ | - | ditaa in | - | v - +--------+ +--------+----+ /---------------\ - | |---+ Asciidoctor +--->| | - | Text | +-------------+ | Beautiful | - |Document| | !magic! | | Output | - | {d}| | | | | - +---+----+ +-------------+ \---------------/ - : ^ - | Lots of work | - +-----------------------------------+ -.... - - - -== GraphViz - -This section contains a diagram -[graphviz] -.... -graph { - a -- b; b -- c; c -- d; d -- e; e -- f; a -- f; a -- c[color=red]; - a -- d; a -- e; b -- d; b -- e; b -- f; c -- e; c -- f; - d -- f; -} -.... http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc b/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc deleted file mode 100644 index 6b2b326..0000000 --- a/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc +++ /dev/null @@ -1,273 +0,0 @@ -# Release Guide of Apache Tamaya (incubating) - -This directory contains the release guide of Apache Tamaya (incubating). -======= -Apache Tamaya -- Release Guide -============================== -:name: Tamaya -:title: Apache Tamaya Release Guide -:revnumber: 0.1-SNAPSHOT -:revremark: Incubator -:revdate: March 2016 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: -// 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. -''' - -<<< - -image::http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png[] - -toc::[] - -<<< -:numbered!: ------------------------------------------------------------ -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. ------------------------------------------------------------ - -:numbered: - - -Performing a release requires several steps. This document describes each step, so everybody in the committer's -team should be able to perform the release procedure. - - -== Tell the others you would proceed with the release procedure - -[listing,text] ----------------------------------------- - first steps for the next release - - hi @ all, - - if there are no objections, i'll start with the first steps for the next release (review, documentation,...). - it would be great to start with the release procedure next week. - - regards, - [name] ----------------------------------------- - - -== Check everything is ready - -* Check the jenkins builds. -* Ensure all JIRA-tickets targeting the release are resolved. If not, get in contact with the ticket - owner/assignee to check - ** if the ticket can be postponed for the next release - ** how long it takes to resolve it and if one can help. - - -== Prepare the release - -* Create release notes and commit them to `tamaya/readme/` (format `ReleaseNotes-[version].html`) -* Create a release branch in git and switch to this branch: - -[listing,text] ----------------------------------------- - git checkout -b vote-tamaya-[release version] - - export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m" - mvn release:prepare -DdryRun=true - - //copy prepared workspace (to continue faster if an upload fails in the next step) ----------------------------------------- - -* If something fails you may switch to the master branch, fix whatever is needed and rebase your release branch to - accomodate the latest changes done. -* On success you can check the release packages from `dist/target`. -* If everything looks good you can proceed with the release: - -[listing,text] ----------------------------------------- - export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m" - mvn release:prepare - mvn release:perform ----------------------------------------- - -* check the created commits including user-name and email -* login to https://repository.apache.org/ and go to "Staging Repositories" -* check the contents of the newly created tamaya staging repository -* _close_ the repository to let Nexus do its validations -* On success: -* push the release-branch to the git repo - -[listing,text] ----------------------------------------- -git push ----------------------------------------- - -* Add the distributiong artifacts to the dev repositories: - -[listing,text] ----------------------------------------- - svn co https://dist.apache.org/repos/dist/dev/incubator/tamaya/ - mkdir [version] - set RELEASE_HOME='pwd'/[version] - cd PROJECT_ROOT - cp DISCLAIMER $RELEASE_HOME - cp NOTICE $RELEASE_HOME - cp LICENCE $RELEASE_HOME - cp readme/ReleaseNotes-[version].html $RELEASE_HOME - curl https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-source-release.zip $RELEASE_HOME - curl https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-source-release.tar.gz $RELEASE_HOME - curl https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-bin-release.zip $RELEASE_HOME - curl https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-bin-release.tar.gz $RELEASE_HOME - // add corresponding asc, md5, sha1 file as well - svn add [version] - svn commit --username <apacheId> ----------------------------------------- - -* Check contents on https://dist.apache.org/repos/dist/dev/incubator/tamaya/[version] - - -== Start the vote - -[listing,text] ----------------------------------------- - [VOTE] Release of Apache Tamaya [version] - - - Hi, - - I was running the needed tasks to get the [version] release of Apache Tamaya out. - The artifacts are deployed to Nexus [1] (and [2]). - - The tag is available at [3] and will renamed once the vote passed. - - Please take a look at the artifacts and vote! - - Please note: - This vote is a "majority approval" with a minimum of three +1 votes (see [4]). - - ------------------------------------------------ - [ ] +1 for community members who have reviewed the bits - [ ] +0 - [ ] -1 for fatal flaws that should cause these bits not to be released, and why.............. - ------------------------------------------------ - - Thanks, - [name] - - [1] https://repository.apache.org/content/repositories/... - [2] https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-source-release.zip - https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-bin-release.zip - [3] https://git1-us-west.apache.org/repos/asf?p=incubator-tamaya.git;a=commit;h=2910da468fce16210e6dd77d8ba23ddbdd434efe - [4] http://www.apache.org/foundation/voting.html#ReleaseVotes ----------------------------------------- - -* Announce the Vote - ** Create a short link to the release at http://s.apache.org (format Tamaya_[version]) - ** Tweet about the vote via _@TamayaConf_ - -* After 72 hours close the vote write a reult email, e.g. - -[listing,text] ----------------------------------------- - [Result] (was: Re: [VOTE] Release of Apache Tamaya [version]) - - thank you for voting! - - X binding +1 votes (pmc): - [list] - - Y non-binding +1 votes: - [list] - - Z -1 votes - [list] ----------------------------------------- - - -== Perform the release - -If the binding majority approved the vote continue: - -* Login to https://repository.apache.org/ and _release_ the repository -* Rename the vote branch: - -[listing,text] ----------------------------------------- - git branch -m vote-tamaya-[version] tamaya-[version] ----------------------------------------- - -* Add a release tag: - ----------------------------------------- - git tag -a tamaya-[version] ----------------------------------------- - -* Merge master with the new prepared version: - -[listing,text] ----------------------------------------- - git checkout master - git merge tamaya-[version] - git push origin tamaya-[version] - git push origin master ----------------------------------------- - -* Close the release and corresponding tickets at JIRA - -* Wait some minutes and check `http://repo2.maven.org/maven2/org/apache/tamaya` - -* Upload the distribution Artifacts - -[listing,text] ----------------------------------------- - svn co https://dist.apache.org/repos/dist/release/incubator/tamaya/ - mkdir [version] - // add and commit the artifacts (*source-release.zip, *bin-release.zip + asc, md5, sha1) - // use the artifacts from: - // http://repo1.maven.org/maven2/org/apache/tamaya/tamaya-distribution/[version]/ ----------------------------------------- - - -== Updating the Tamaya Project Site - -Currently Tamaya's Site located at https://svn.apache.org/repos/asf/incubator/tamaya/site/trunk must be updated -manually. This should change in the future (then a simple mvn site site:deploy) should be sufficient. This -includes: - -* Updating the entry pages with the new release -* Updating the news page with the new release -* Updating all Javadocs published on the site -* Updating the documentation htmls generated from asciidoc http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/combine-configs.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/combine-configs.adoc b/docs/src/main/asciidoc/uc/combine-configs.adoc deleted file mode 100644 index 2d83ab7..0000000 --- a/docs/src/main/asciidoc/uc/combine-configs.adoc +++ /dev/null @@ -1,14 +0,0 @@ -=== Combine Configurations - -Users want to be able to combine different configurations to a new configuration instance. -Hereby the resulting configuration can be - -* a union of both, ignoring duplicates (and optionally log them) -* a union of both, duplicates are ignored -* a union of both, conflicts are thrown as ConfigException -* an intersection of both, containing only keys present and equal in both configurations -* an arbitrary mapping or filter, modelled by an +CombinationPolicy+, which basically can be modelled - as +BiFunction<String, String, String>+, hereby - ** a result of +null+ will remove the key - ** any other result will use the value returned as final value of the combination. - http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/context-dependent-configuration.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/context-dependent-configuration.adoc b/docs/src/main/asciidoc/uc/context-dependent-configuration.adoc deleted file mode 100644 index 737232f..0000000 --- a/docs/src/main/asciidoc/uc/context-dependent-configuration.adoc +++ /dev/null @@ -1,7 +0,0 @@ -=== Context Dependent Configuration - -In multi tenancy setups or complex systems a hierarchical/graph model of contexts for configurations is required, or different runtime contexts are executed in parallel -within the same VN. What sounds normal for EE also may be the case for pure SE environments: - -* Users want to be able to model different layers of runtime context -* Users want to identiofy the current layer, so configuration used may be adapted. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/dynamic-provisioning.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/dynamic-provisioning.adoc b/docs/src/main/asciidoc/uc/dynamic-provisioning.adoc deleted file mode 100644 index 1629914..0000000 --- a/docs/src/main/asciidoc/uc/dynamic-provisioning.adoc +++ /dev/null @@ -1,18 +0,0 @@ -=== Dynamic Provisioning (UC8) - -In Cloud Computing, especially the PaaS and SaaS areas a typical use case would be that an application (or server) -is deployed, configured and started dynamically. Typically things are controlled by some "active controller components", -which are capable of - -* creating new nodes (using IaaS services) -* deploying and starting the required runtime platform , e.g. as part of a PaaS solution. -* deploying and starting the application modules. - -All these steps require some kind of configuration. As of today required files are often created on the target node -before the systems are started, using proprietary formats and mechanism. Similarly accessing the configuration in place -may require examining the file system or using again proprietary management functions. Of course, a configuration -solution should not try to solve that, but it can provide a significant bunch of functionality useful in such scenarios: - -* provide remote capabilities for configuration -* allow configuration to be updated remotely. -* allow client code to listen for configuration changes and react as needed. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/external-configuration.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/external-configuration.adoc b/docs/src/main/asciidoc/uc/external-configuration.adoc deleted file mode 100644 index ea2e687..0000000 --- a/docs/src/main/asciidoc/uc/external-configuration.adoc +++ /dev/null @@ -1,6 +0,0 @@ -=== External Configuration - -Users want to be able to replace, override, extend or adapt any parts or all of an existing configuration from -external sources. -This also must be the case for multi-context environments, where the context identifiers are -the only way to link to the correct remote configuration. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/formats.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/formats.adoc b/docs/src/main/asciidoc/uc/formats.adoc deleted file mode 100644 index a5a1bf7..0000000 --- a/docs/src/main/asciidoc/uc/formats.adoc +++ /dev/null @@ -1,8 +0,0 @@ -=== Configuration Formats - -Users want to be able to use the format they prefer. - -* properties, xml-properties and ini-format should be supported by default -* Other/custom formats should be easily addable by registering or providing the format on configuration evaluation (read). -* When possible Tamaya should figure out which format to be used and how the InputStream should be correctly - interpreted. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/injection.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/injection.adoc b/docs/src/main/asciidoc/uc/injection.adoc deleted file mode 100644 index 4468d6c..0000000 --- a/docs/src/main/asciidoc/uc/injection.adoc +++ /dev/null @@ -1,31 +0,0 @@ -=== Configuration Injection - -Users want to be able to polulate configured items by injecting configured values. Hereby - -* the lifecycle of the instances is not managed by Tamaya -* all references to items configured are managed as weak references, to prevent memoryleaks. -* Injection should if possible evaluate the properties by defaults. Even properties without - any annotations are possible. -* Users expect to exclude certain properties from calculation -* Beside injection of properties it is also possible to call setter methods with one parameter similarly. -* Basically injection is performed, when the instance is passed to the Tamaya configuration system. It should also - be possible to inject/provide final values, especially Strings. Changes on configured values should be - reflected in the current value. Setters methods similarly can be called again, with the new values, on changes. -* Users expect to control dynamic values and recall of setter methods, basically the following strategies should be - supported: - ** inject only once and ignore further changes. - ** reinject/reinitialize on each change - -* Dynamic Values can easily be modeled as +ConfiguredValue+ instances, which should have the following functionality: - ** access the current value - ** access the new value - ** access the latest value access time in ms - ** access the latest value update time in ms - ** evaluate easily if the value has changed since the last access - ** accept the change - *** as a shortcut it should be possible to accept the change on access of the value implicitly, hereby always accessing - the latest valid value. - ** ignore the change - ** register +Consumer<DynamicValue>+ liasteners to listen on the changes (ans also removing them later again). - -All observing functionality can be done completely asynchronously and in parallel. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/java8.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/java8.adoc b/docs/src/main/asciidoc/uc/java8.adoc deleted file mode 100644 index 0cdf069..0000000 --- a/docs/src/main/asciidoc/uc/java8.adoc +++ /dev/null @@ -1,14 +0,0 @@ -=== Java 8 Functional Support - -Users want to be able to benefit from the new programming styles introduced with Java 8. Configuration -should provide extension points for different aspects, where additional code can be hooked in easily. -In short: were possible functional interfaces should be modelled. - -Examples: - -* code that converts a configuration to another kind of configuration: +UnaryOperator<Configuration>+ -* code that creates any kind of result based on a configuration: +Function<Configuration,T>+ -* Adapters for type conversion are defined as +Function<String,T>+ -* Key, value filters ccan be modelled as +BiFunction<String,String,String>+ -* etc. - http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/locations.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/locations.adoc b/docs/src/main/asciidoc/uc/locations.adoc deleted file mode 100644 index 5e0f774..0000000 --- a/docs/src/main/asciidoc/uc/locations.adoc +++ /dev/null @@ -1,10 +0,0 @@ -=== Configuration Locations - -Users want to be able to - -* read configuration from different locations. -* By default classpath and file resources are - supported. But similarly remote access using a JSON ReST call should be possible. -* Tamaya should define a JSON and XML format for configuration. -* Configuration locations should be scannable using ant-styled resource patterns, if possible. -* Scanning and reading logic can be modularized by using a +ConfigReader+ interface. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/management.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/management.adoc b/docs/src/main/asciidoc/uc/management.adoc deleted file mode 100644 index ff997a5..0000000 --- a/docs/src/main/asciidoc/uc/management.adoc +++ /dev/null @@ -1,7 +0,0 @@ -=== MX/ReST Management - -Users want to be have comprehensive management support, which should allow - -* to change configuration -* to remove configuration -* to view configuration and its provider details \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/minimal-propertysource.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/minimal-propertysource.adoc b/docs/src/main/asciidoc/uc/minimal-propertysource.adoc deleted file mode 100644 index ee185a0..0000000 --- a/docs/src/main/asciidoc/uc/minimal-propertysource.adoc +++ /dev/null @@ -1,6 +0,0 @@ -=== Minimal Property Source SPI - -Users expect that implementing an additional configuration property source is as easy as possible. -So there should be an SPI defined that allows any kind of data source to be used for providing configuration data. -The interface to be implemented is expected to be minimal to reduce the implementation burden. Default -methods should be used where possible, so only a few methods are expected to be required to implement. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/multiple-configurations.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/multiple-configurations.adoc b/docs/src/main/asciidoc/uc/multiple-configurations.adoc deleted file mode 100644 index 2ee133f..0000000 --- a/docs/src/main/asciidoc/uc/multiple-configurations.adoc +++ /dev/null @@ -1,14 +0,0 @@ -=== Multiple Configurations - -When systems grow they must be modularized to keep control. Whereas that sounds not really fancy, it leads to additional -aspects to be considered by a configuration system. - -* Different code modules, libraries, plugins or products want to have their "own" separated configuration. -* Similar it should be possible to add fully specific additional configurations. - -The default configuration hereby should always be present, whereas additional configurations are optional. -Users want to be able to check the availability of such an additional configuration. - -Of course, additional configuration must be identifiable. The best way to do is to be discussed, nevertheless the -mechanism must not depend on Java EE and the identifying keys must be serializable easily. -Basically simple names are sufficient and woukld provide exact this required functionality. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/scannable-properties.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/scannable-properties.adoc b/docs/src/main/asciidoc/uc/scannable-properties.adoc deleted file mode 100644 index e2a6b64..0000000 --- a/docs/src/main/asciidoc/uc/scannable-properties.adoc +++ /dev/null @@ -1,4 +0,0 @@ -=== Scannable Properties - -If possible configuration should be scannable, meaning it should be possible to evaluate the keys available. -The corresponding capabilities should be accessible by a +isScannable()+ method. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/service-context.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/service-context.adoc b/docs/src/main/asciidoc/uc/service-context.adoc deleted file mode 100644 index ceeea4a..0000000 --- a/docs/src/main/asciidoc/uc/service-context.adoc +++ /dev/null @@ -1,15 +0,0 @@ -=== Adaptable Service Context - -Tamaya should support an adaptable +ServiceContext+ to resolve any kind of implememntation services, both API services as core -framework services. The +ServiceContext+ should be dynamically replecable by configuring an alternate instance of -using the Java *ServiceContet+. - -This decouples component usage from its load and management part and als greatly simplifies integration with -new/alternate runtime environments. -The service context is exptected to provide - -* single singleton instances: these service can be cached. -* access to multiple instances which implement some commons SPI interface. -* as useful priorization of components is done by the model itself. - - http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/simple-access.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/simple-access.adoc b/docs/src/main/asciidoc/uc/simple-access.adoc deleted file mode 100644 index d4ada1e..0000000 --- a/docs/src/main/asciidoc/uc/simple-access.adoc +++ /dev/null @@ -1,25 +0,0 @@ -=== Simple Access - -Users want to be able to access configuration in a unified way both in SE and EE. EE may provide additional -mechanism, such as injection, but the SE mechanisms should work as well, so any code written in SE is fully -portable to EE as well. -This can only be achieved by providing a static accessor, e.g. - -[source,java] ------------------------------------------------------------- -Configuration config = Configuration.current(); ------------------------------------------------------------- - -The call above should work exactly the same in EE. To enable this the static call must be delegated in the -internals of the singleton, depending on the runtime. In EE the executing component can behave contextually, -or even be loaded within the CDI environment (at least for post loading, application runtime aspects, but not earlier). - -Additionally in EE it should also be possible to inject Configuration, which gives you the same results as the call -above: - -[source,java] ------------------------------------------------------------- -@Inject -private Configuration cfg; ------------------------------------------------------------- - http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/simple-property-access.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/simple-property-access.adoc b/docs/src/main/asciidoc/uc/simple-property-access.adoc deleted file mode 100644 index 81fb879..0000000 --- a/docs/src/main/asciidoc/uc/simple-property-access.adoc +++ /dev/null @@ -1,9 +0,0 @@ -=== Simple Lookup of Properties - -Users just want to create a configuration ad hoc, from given property files. The -files could be locally in the file system, on the classpath. - -Tamaya should provide a simple Java API for accessing key/value based configuration. Hereby users want to access -properties as simple String values. - -Hereby returning Java 8 Optional values must be considered as well, instead of returning +null+. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/templates.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/templates.adoc b/docs/src/main/asciidoc/uc/templates.adoc deleted file mode 100644 index 2aab3d2..0000000 --- a/docs/src/main/asciidoc/uc/templates.adoc +++ /dev/null @@ -1,12 +0,0 @@ -=== Configuration Templates - -Users want to be able to let Tamaya implement an interface template based on configuration. -This use case is pretty similar to the injection use case. Basically the values are not injected, -but cached within the template proxy returned, e.g. as +DynamicValue+. -Similarly it could even be possible to define callback methods (default methods) -or register listeners to DynamicValue instances returned. - -Templates hereby can easily be managed, but provide a excellent mechanism to provide type-safe configuration -to clients in a very transparent way. Details can be controlled by using the same annotations as for -normal configuration injection. - http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/type-safe-properties.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/type-safe-properties.adoc b/docs/src/main/asciidoc/uc/type-safe-properties.adoc deleted file mode 100644 index e71d31c..0000000 --- a/docs/src/main/asciidoc/uc/type-safe-properties.adoc +++ /dev/null @@ -1,10 +0,0 @@ -=== Type Safe Properties - -Users just want to access properties not only as Strings, but let Tamaya do the conversion to the required -or the configred target type. By defauklt all java.lang wrapper and primitive types should be supported, but also -other common types like date/time types, math numeric types and more. - -It must be possible that users can register their own custom types. - -Finally users also want to be able to dynamically provide or override type adaption (conversion), when reading a value, -for a certain key/value pair. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/uc/value-placeholders.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/uc/value-placeholders.adoc b/docs/src/main/asciidoc/uc/value-placeholders.adoc deleted file mode 100644 index 57857a8..0000000 --- a/docs/src/main/asciidoc/uc/value-placeholders.adoc +++ /dev/null @@ -1,8 +0,0 @@ -=== Value Placeholders - -Users just want to to be able to add placeholders to the values of configuration (not the keys). The mechanisms for -resolving the placeholders hereby should be not constraint to one single lanmguage like EL. Instead of different -replacement strategies should be selectable, e.g. by prefixing an expression with the name of the resolver that -should do the work (eg +"blabla ${env:HOME} using Java version ${sys:java.version}."+. -This allows resolution mechanism to be isolated easily and also allows to use simpler mechanisms, if no more complex -ones like EL are required. This is especially useful to deal with low resource environment like ME. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/asciidoc/usecases.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/usecases.adoc b/docs/src/main/asciidoc/usecases.adoc deleted file mode 100644 index fb36344..0000000 --- a/docs/src/main/asciidoc/usecases.adoc +++ /dev/null @@ -1,58 +0,0 @@ -= Apache Tamaya -- Use Cases -:name: Tamaya -:rootpackage: org.apache.tamaya -:title: Apache Tamaya -:revnumber: 0.1-SNAPSHOT -:revremark: Incubator -:revdate: November 2014 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: OBF -:author: Oliver B. Fischer -:email: <ple...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: -// 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. -toc::[] - - -== Use Cases for Java SE Environments - -include::src/main/asciidoc/uc/simple-access.adoc[] -include::src/main/asciidoc/uc/simple-property-access.adoc[] -include::src/main/asciidoc/uc/value-placeholders.adoc[] -include::src/main/asciidoc/uc/type-safe-properties.adoc[] -include::src/main/asciidoc/uc/templates.adoc[] -include::src/main/asciidoc/uc/java8.adoc[] -include::src/main/asciidoc/uc/locations.adoc[] -include::src/main/asciidoc/uc/formats.adoc[] -include::src/main/asciidoc/uc/multiple-configurations.adoc[] -include::src/main/asciidoc/uc/external-configuration.adoc[] -include::src/main/asciidoc/uc/context-dependent-configuration.adoc[] -include::src/main/asciidoc/uc/dynamic-provisioning.adoc[] -include::src/main/asciidoc/uc/minimal-propertysource.adoc[] -include::src/main/asciidoc/uc/scannable-properties.adoc[] -include::src/main/asciidoc/uc/combine-configs.adoc[] -include::src/main/asciidoc/uc/management.adoc[] -include::src/main/asciidoc/uc/service-context.adoc[] -include::src/main/asciidoc/uc/injection.adoc[] - - http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/assembly/documentation.xml ---------------------------------------------------------------------- diff --git a/docs/src/main/assembly/documentation.xml b/docs/src/main/assembly/documentation.xml index 0f8b11d..501a0c6 100644 --- a/docs/src/main/assembly/documentation.xml +++ b/docs/src/main/assembly/documentation.xml @@ -29,11 +29,9 @@ under the License. </formats> <fileSets> - <fileSet> - <directory>${project.build.directory}/adocs</directory> + <directory>${project.directory}/../src/site/asciidoc</directory> <outputDirectory>docs</outputDirectory> - </fileSet> </fileSets> </assembly> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/docs/src/main/images/CoreDesign.png ---------------------------------------------------------------------- diff --git a/docs/src/main/images/CoreDesign.png b/docs/src/main/images/CoreDesign.png deleted file mode 100644 index a84d8a6..0000000 Binary files a/docs/src/main/images/CoreDesign.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/1-minimal-example/pom.xml ---------------------------------------------------------------------- diff --git a/examples/1-minimal-example/pom.xml b/examples/1-minimal-example/pom.xml index c9d157f..900a90d 100644 --- a/examples/1-minimal-example/pom.xml +++ b/examples/1-minimal-example/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-examples</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-minimal</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/2-simple-propertysource-example/pom.xml ---------------------------------------------------------------------- diff --git a/examples/2-simple-propertysource-example/pom.xml b/examples/2-simple-propertysource-example/pom.xml index 8d8e6b6..41306ab 100644 --- a/examples/2-simple-propertysource-example/pom.xml +++ b/examples/2-simple-propertysource-example/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-examples</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-simple-propertysource</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/3-resources-example/pom.xml ---------------------------------------------------------------------- diff --git a/examples/3-resources-example/pom.xml b/examples/3-resources-example/pom.xml index 3d594c9..ec9ae47 100644 --- a/examples/3-resources-example/pom.xml +++ b/examples/3-resources-example/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-examples</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-resources</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/4-resolver-example/pom.xml ---------------------------------------------------------------------- diff --git a/examples/4-resolver-example/pom.xml b/examples/4-resolver-example/pom.xml index 9602c5d..3cc724e 100644 --- a/examples/4-resolver-example/pom.xml +++ b/examples/4-resolver-example/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-examples</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-resolver</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/5-injection-example/pom.xml ---------------------------------------------------------------------- diff --git a/examples/5-injection-example/pom.xml b/examples/5-injection-example/pom.xml index 6aff00c..1dfcc4c 100644 --- a/examples/5-injection-example/pom.xml +++ b/examples/5-injection-example/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-examples</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-injection</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/6-fileobserver-example/pom.xml ---------------------------------------------------------------------- diff --git a/examples/6-fileobserver-example/pom.xml b/examples/6-fileobserver-example/pom.xml index 5b12c5f..c22ed27 100644 --- a/examples/6-fileobserver-example/pom.xml +++ b/examples/6-fileobserver-example/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-examples</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-fileobserver</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/7-builder-example/pom.xml ---------------------------------------------------------------------- diff --git a/examples/7-builder-example/pom.xml b/examples/7-builder-example/pom.xml index 94c5a7e..7d95305 100644 --- a/examples/7-builder-example/pom.xml +++ b/examples/7-builder-example/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-examples</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-builder</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/8-remote-example/client/pom.xml ---------------------------------------------------------------------- diff --git a/examples/8-remote-example/client/pom.xml b/examples/8-remote-example/client/pom.xml index 6bfafd7..6bab59b 100644 --- a/examples/8-remote-example/client/pom.xml +++ b/examples/8-remote-example/client/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.examples</groupId> <artifactId>tamaya-example-remote</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-remote-client</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/8-remote-example/pom.xml ---------------------------------------------------------------------- diff --git a/examples/8-remote-example/pom.xml b/examples/8-remote-example/pom.xml index 8b18a6d..8985e33 100644 --- a/examples/8-remote-example/pom.xml +++ b/examples/8-remote-example/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-examples</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-remote</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/8-remote-example/server/pom.xml ---------------------------------------------------------------------- diff --git a/examples/8-remote-example/server/pom.xml b/examples/8-remote-example/server/pom.xml index d21c863..02e26fe 100644 --- a/examples/8-remote-example/server/pom.xml +++ b/examples/8-remote-example/server/pom.xml @@ -21,7 +21,7 @@ under the License. <parent> <groupId>org.apache.tamaya.examples</groupId> <artifactId>tamaya-example-remote</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-example-remote-server</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/examples/pom.xml ---------------------------------------------------------------------- diff --git a/examples/pom.xml b/examples/pom.xml index df7e369..9cbb8ac 100644 --- a/examples/pom.xml +++ b/examples/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya</groupId> <artifactId>tamaya-all</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/builder/pom.xml ---------------------------------------------------------------------- diff --git a/modules/builder/pom.xml b/modules/builder/pom.xml index 96f6244..32dc6b5 100644 --- a/modules/builder/pom.xml +++ b/modules/builder/pom.xml @@ -23,7 +23,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-builder</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/classloader-support/pom.xml ---------------------------------------------------------------------- diff --git a/modules/classloader-support/pom.xml b/modules/classloader-support/pom.xml index 1d27df4..24322dd 100644 --- a/modules/classloader-support/pom.xml +++ b/modules/classloader-support/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/collections/pom.xml ---------------------------------------------------------------------- diff --git a/modules/collections/pom.xml b/modules/collections/pom.xml index 44200bd..db22903 100644 --- a/modules/collections/pom.xml +++ b/modules/collections/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/events/pom.xml ---------------------------------------------------------------------- diff --git a/modules/events/pom.xml b/modules/events/pom.xml index 74d3a4b..21269ed 100644 --- a/modules/events/pom.xml +++ b/modules/events/pom.xml @@ -23,7 +23,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-events</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/filter/pom.xml ---------------------------------------------------------------------- diff --git a/modules/filter/pom.xml b/modules/filter/pom.xml index d9d4854..6222349 100644 --- a/modules/filter/pom.xml +++ b/modules/filter/pom.xml @@ -23,7 +23,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-filter</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/formats/pom.xml ---------------------------------------------------------------------- diff --git a/modules/formats/pom.xml b/modules/formats/pom.xml index baf3666..71b3912 100644 --- a/modules/formats/pom.xml +++ b/modules/formats/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-formats</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/functions/pom.xml ---------------------------------------------------------------------- diff --git a/modules/functions/pom.xml b/modules/functions/pom.xml index 88d95e4..1009298 100644 --- a/modules/functions/pom.xml +++ b/modules/functions/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/injection-api/pom.xml ---------------------------------------------------------------------- diff --git a/modules/injection-api/pom.xml b/modules/injection-api/pom.xml index 9b2d580..e4fc7b7 100644 --- a/modules/injection-api/pom.xml +++ b/modules/injection-api/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-injection-api</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/injection/pom.xml ---------------------------------------------------------------------- diff --git a/modules/injection/pom.xml b/modules/injection/pom.xml index eae751c..f40c472 100644 --- a/modules/injection/pom.xml +++ b/modules/injection/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-injection</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/integration/camel/pom.xml ---------------------------------------------------------------------- diff --git a/modules/integration/camel/pom.xml b/modules/integration/camel/pom.xml index 07adc0b..ff62b8a 100644 --- a/modules/integration/camel/pom.xml +++ b/modules/integration/camel/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-integration</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-camel</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/integration/cdi-se/pom.xml ---------------------------------------------------------------------- diff --git a/modules/integration/cdi-se/pom.xml b/modules/integration/cdi-se/pom.xml index bcaf441..a0dfc3f 100644 --- a/modules/integration/cdi-se/pom.xml +++ b/modules/integration/cdi-se/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-integration</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-cdi-se</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/integration/cdi/pom.xml ---------------------------------------------------------------------- diff --git a/modules/integration/cdi/pom.xml b/modules/integration/cdi/pom.xml index df7288a..caa1527 100644 --- a/modules/integration/cdi/pom.xml +++ b/modules/integration/cdi/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-integration</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-cdi</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/integration/consul/pom.xml ---------------------------------------------------------------------- diff --git a/modules/integration/consul/pom.xml b/modules/integration/consul/pom.xml index d1f5265..879d484 100644 --- a/modules/integration/consul/pom.xml +++ b/modules/integration/consul/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-integration</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-consul</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/integration/etcd/pom.xml ---------------------------------------------------------------------- diff --git a/modules/integration/etcd/pom.xml b/modules/integration/etcd/pom.xml index 7520822..ac6f14b 100644 --- a/modules/integration/etcd/pom.xml +++ b/modules/integration/etcd/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-integration</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-etcd</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/integration/osgi/pom.xml ---------------------------------------------------------------------- diff --git a/modules/integration/osgi/pom.xml b/modules/integration/osgi/pom.xml index 3fa6516..23f0da2 100644 --- a/modules/integration/osgi/pom.xml +++ b/modules/integration/osgi/pom.xml @@ -24,7 +24,7 @@ <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-integration</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-osgi</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/integration/pom.xml ---------------------------------------------------------------------- diff --git a/modules/integration/pom.xml b/modules/integration/pom.xml index df4775d..b887700 100644 --- a/modules/integration/pom.xml +++ b/modules/integration/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <packaging>pom</packaging> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/integration/spring/pom.xml ---------------------------------------------------------------------- diff --git a/modules/integration/spring/pom.xml b/modules/integration/spring/pom.xml index ee1628c..0feaa9b 100644 --- a/modules/integration/spring/pom.xml +++ b/modules/integration/spring/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-integration</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> </parent> <artifactId>tamaya-spring</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/json/pom.xml ---------------------------------------------------------------------- diff --git a/modules/json/pom.xml b/modules/json/pom.xml index 49f4629..670516c 100644 --- a/modules/json/pom.xml +++ b/modules/json/pom.xml @@ -23,7 +23,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-json</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/management/pom.xml ---------------------------------------------------------------------- diff --git a/modules/management/pom.xml b/modules/management/pom.xml index 8603cf9..4953682 100644 --- a/modules/management/pom.xml +++ b/modules/management/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/model/pom.xml ---------------------------------------------------------------------- diff --git a/modules/model/pom.xml b/modules/model/pom.xml index b121c24..521d714 100644 --- a/modules/model/pom.xml +++ b/modules/model/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/mutable-config/pom.xml ---------------------------------------------------------------------- diff --git a/modules/mutable-config/pom.xml b/modules/mutable-config/pom.xml index 0ddd7bf..38cabbc 100644 --- a/modules/mutable-config/pom.xml +++ b/modules/mutable-config/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/optional/pom.xml ---------------------------------------------------------------------- diff --git a/modules/optional/pom.xml b/modules/optional/pom.xml index 622c3f7..142bdd8 100644 --- a/modules/optional/pom.xml +++ b/modules/optional/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/pom.xml ---------------------------------------------------------------------- diff --git a/modules/pom.xml b/modules/pom.xml index e32b92f..d85849c 100644 --- a/modules/pom.xml +++ b/modules/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya</groupId> <artifactId>tamaya-all</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/resolver/pom.xml ---------------------------------------------------------------------- diff --git a/modules/resolver/pom.xml b/modules/resolver/pom.xml index 596abb7..eb9af80 100644 --- a/modules/resolver/pom.xml +++ b/modules/resolver/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-resolver</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/resources/pom.xml ---------------------------------------------------------------------- diff --git a/modules/resources/pom.xml b/modules/resources/pom.xml index 1ba7dbe..369a839 100644 --- a/modules/resources/pom.xml +++ b/modules/resources/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-resources</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/server/pom.xml ---------------------------------------------------------------------- diff --git a/modules/server/pom.xml b/modules/server/pom.xml index 55c75ec..7e34018 100644 --- a/modules/server/pom.xml +++ b/modules/server/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/spi-support/pom.xml ---------------------------------------------------------------------- diff --git a/modules/spi-support/pom.xml b/modules/spi-support/pom.xml index 62082eb..af70402 100644 --- a/modules/spi-support/pom.xml +++ b/modules/spi-support/pom.xml @@ -22,7 +22,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/modules/yaml/pom.xml ---------------------------------------------------------------------- diff --git a/modules/yaml/pom.xml b/modules/yaml/pom.xml index 483b6a9..f659efb 100644 --- a/modules/yaml/pom.xml +++ b/modules/yaml/pom.xml @@ -23,7 +23,7 @@ under the License. <parent> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-extensions</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <relativePath>..</relativePath> </parent> <artifactId>tamaya-yaml</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index a109220..0cc6f49 100644 --- a/pom.xml +++ b/pom.xml @@ -26,7 +26,7 @@ under the License. </parent> <groupId>org.apache.tamaya</groupId> <artifactId>tamaya-all</artifactId> - <version>0.3-incubating-SNAPSHOT</version> + <version>0.2-incubating-SNAPSHOT</version> <packaging>pom</packaging> <name>Apache Tamaya</name> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/src/site/asciidoc/release-guide.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/release-guide.adoc b/src/site/asciidoc/release-guide.adoc index ffc9547..49e017e 100644 --- a/src/site/asciidoc/release-guide.adoc +++ b/src/site/asciidoc/release-guide.adoc @@ -1,7 +1,225 @@ +// 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. + = Apache Tamaya -- Release Guide -This document contains the guidelines for Tamaya. +include::temp-properties-files-for-site/attributes.adoc[] + +Performing a release requires several steps. This document describes each step, so everybody in the committer's +team should be able to perform the release procedure. + + +== Tell the others you would proceed with the release procedure + +[listing,text] +---------------------------------------- + first steps for the next release + + hi @ all, + + if there are no objections, i'll start with the first steps for the next release (review, documentation,...). + it would be great to start with the release procedure next week. + + regards, + [name] +---------------------------------------- + + +== Check everything is ready + +* Check the jenkins builds. +* Ensure all JIRA-tickets targeting the release are resolved. If not, get in contact with the ticket + owner/assignee to check + ** if the ticket can be postponed for the next release + ** how long it takes to resolve it and if one can help. + + +== Prepare the release + +* Create release notes and commit them to `tamaya/readme/` (format `ReleaseNotes-[version].html`) +* Create a release branch in git and switch to this branch: + +[listing,text] +---------------------------------------- + git checkout -b vote-tamaya-[release version] + + export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m" + mvn release:prepare -DdryRun=true + + //copy prepared workspace (to continue faster if an upload fails in the next step) +---------------------------------------- + +* If something fails you may switch to the master branch, fix whatever is needed and rebase your release branch to + accomodate the latest changes done. +* On success you can check the release packages from `dist/target`. +* If everything looks good you can proceed with the release: + +[listing,text] +---------------------------------------- + export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m" + mvn release:prepare + mvn release:perform +---------------------------------------- + +* check the created commits including user-name and email +* login to https://repository.apache.org/ and go to "Staging Repositories" +* check the contents of the newly created tamaya staging repository +* _close_ the repository to let Nexus do its validations +* On success: +* push the release-branch to the git repo + +[listing,text] +---------------------------------------- +git push +---------------------------------------- + +* Add the distributiong artifacts to the dev repositories: + +[listing,text] +---------------------------------------- + svn co https://dist.apache.org/repos/dist/dev/incubator/tamaya/ + mkdir [version] + set RELEASE_HOME='pwd'/[version] + cd PROJECT_ROOT + cp DISCLAIMER $RELEASE_HOME + cp NOTICE $RELEASE_HOME + cp LICENCE $RELEASE_HOME + cp readme/ReleaseNotes-[version].html $RELEASE_HOME + curl https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-source-release.zip $RELEASE_HOME + curl https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-source-release.tar.gz $RELEASE_HOME + curl https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-bin-release.zip $RELEASE_HOME + curl https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-bin-release.tar.gz $RELEASE_HOME + // add corresponding asc, md5, sha1 file as well + svn add [version] + svn commit --username <apacheId> +---------------------------------------- + +* Check contents on https://dist.apache.org/repos/dist/dev/incubator/tamaya/[version] + + +== Start the vote + +[listing,text] +---------------------------------------- + [VOTE] Release of Apache Tamaya [version] + + + Hi, + + I was running the needed tasks to get the [version] release of Apache Tamaya out. + The artifacts are deployed to Nexus [1] (and [2]). + + The tag is available at [3] and will renamed once the vote passed. + + Please take a look at the artifacts and vote! + + Please note: + This vote is a "majority approval" with a minimum of three +1 votes (see [4]). + + ------------------------------------------------ + [ ] +1 for community members who have reviewed the bits + [ ] +0 + [ ] -1 for fatal flaws that should cause these bits not to be released, and why.............. + ------------------------------------------------ + + Thanks, + [name] + + [1] https://repository.apache.org/content/repositories/... + [2] https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-source-release.zip + https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-bin-release.zip + [3] https://git1-us-west.apache.org/repos/asf?p=incubator-tamaya.git;a=commit;h=2910da468fce16210e6dd77d8ba23ddbdd434efe + [4] http://www.apache.org/foundation/voting.html#ReleaseVotes +---------------------------------------- + +* Announce the Vote + ** Create a short link to the release at http://s.apache.org (format Tamaya_[version]) + ** Tweet about the vote via _@TamayaConf_ + +* After 72 hours close the vote write a reult email, e.g. + +[listing,text] +---------------------------------------- + [Result] (was: Re: [VOTE] Release of Apache Tamaya [version]) + + thank you for voting! + + X binding +1 votes (pmc): + [list] + + Y non-binding +1 votes: + [list] + + Z -1 votes + [list] +---------------------------------------- + + +== Perform the release + +If the binding majority approved the vote continue: + +* Login to https://repository.apache.org/ and _release_ the repository +* Rename the vote branch: + +[listing,text] +---------------------------------------- + git branch -m vote-tamaya-[version] tamaya-[version] +---------------------------------------- + +* Add a release tag: + +---------------------------------------- + git tag -a tamaya-[version] +---------------------------------------- + +* Merge master with the new prepared version: + +[listing,text] +---------------------------------------- + git checkout master + git merge tamaya-[version] + git push origin tamaya-[version] + git push origin master +---------------------------------------- + +* Close the release and corresponding tickets at JIRA + +* Wait some minutes and check `http://repo2.maven.org/maven2/org/apache/tamaya` + +* Upload the distribution Artifacts + +[listing,text] +---------------------------------------- + svn co https://dist.apache.org/repos/dist/release/incubator/tamaya/ + mkdir [version] + // add and commit the artifacts (*source-release.zip, *bin-release.zip + asc, md5, sha1) + // use the artifacts from: + // http://repo1.maven.org/maven2/org/apache/tamaya/tamaya-distribution/[version]/ +---------------------------------------- + + +== Updating the Tamaya Project Site -TDB +Currently Tamaya's Site located at https://svn.apache.org/repos/asf/incubator/tamaya/site/trunk must be updated +manually. This should change in the future (then a simple mvn site site:deploy) should be sufficient. This +includes: -// Add an instruction to always add the release to the release overview page +* Updating the entry pages with the new release +* Updating the news page with the new release +* Updating all Javadocs published on the site +* Updating the documentation htmls generated from asciidoc http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/3854cc22/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 7afd539..6cf5a5f 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -40,16 +40,17 @@ under the License. <menu name="Documentation"> <item name="Quickstart" href="quickstart.html"/> + <item name="User Guide" href="userguide/index.html"/> <item name="Extension Guide" href="extensions/index.html"/> <item name="${project.version} JavaDoc" target="" href="apidocs/index.html"/> </menu> <menu name="Development"> - <item name="Release Guide" href="release-guide.html"/> - <item name="Development Guide" href="devguide/"/> + <item name="Sources" href="source.html"/> <item name="Community" href="community.html"/> <item name="Issues" href="https://issues.apache.org/jira/browse/TAMAYA" target="_blank"/> - <item name="Sources" href="source.html"/> + <item name="Development Guide" href="devguide/"/> + <item name="Release Guide" href="release-guide.html"/> </menu> <menu name="Reports" ref="reports"> @@ -58,7 +59,6 @@ under the License. <menu name="Releases"> <item name="Download" href="download.html"/> <item name="Release History" href="history.html"/> - </menu> </body>