This is an automated email from the ASF dual-hosted git repository. gk pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/turbine-fulcrum-build.git
commit 54f021905d3b2b090261db23c1718099ad312f95 Merge: 6b86220 be45853 Author: Georg Kallidis <[email protected]> AuthorDate: Tue Oct 5 15:15:36 2021 +0100 update README.md, cleanup, add more git relevant hints .gitmodules | 3 +++ README.md | 30 +++++++++++++++++------------- pom.xml | 3 +-- upload | 1 + 4 files changed, 22 insertions(+), 15 deletions(-) diff --cc README.md index 628d473,c235b4f..cb53e98 --- a/README.md +++ b/README.md @@@ -22,15 -23,15 +22,12 @@@ instructions on building. This documen https://maven.apache.org/guides/getting-started/ -- ### GIT -------------------------------------------- - You could use git to checkout current trunk: git clone --recurse-submodules https://github.com/apache/turbine-fulcrum-build.git -- To update submodules: git pull --recurse-submodules @@@ -38,21 -39,34 +35,29 @@@ To merge and fast-forward git submodule update --remote --merge -- ## Documentation --------------------------------------------------------------------------- - Each component has its section [here](https://turbine.apache.org/fulcrum/). ## Requirements --------------------------------------------------------------------------- - Fulcrum Components requires Java 8. Older components might require Java 7 only. -- - ----------------------------------------------------------------------- + ## COMPONENT DEVELOPMENT --------------------------------------------------------------------------- + ### Adding Fulcrum component + + git submodule add https://gitbox.apache.org/repos/asf/turbine-fulcrum-upload.git upload + + This will immediately clone the repo into folder upload. + + Edit in pom and add module + + <module>upload</module> + + Test it, by running mvn install + ### Publishing Workflow #### Prerequisites @@@ -98,17 -112,12 +103,16 @@@ And finally 2. Remote Testing -- May require explicit authentication with -Dusername=<username> -Dpassword=<pw> +As we using git as svn, be sure that you execute the steps in master/trunk/main branch as git commands are applied to the current branch. -**Multi Module** +Find more Information in [Turbine Release Manual](https://cwiki.apache.org/confluence/display/TURBINE/Publishing+a+Release). + +If you have not set ssh-key or gpg authentication, the tasks may require that you explicitely authenticate with -Dusername=<username> -Dpassword=<pw>. - mvn release:prepare -DautoVersionSubmodules=true -P apache-release +**Multi Module** + mvn release:prepare -DautoVersionSubmodules=true -Papache-release -Dtag=<project.artifact>-<version>-candidate + - Important: Success will be on the master build, the others are skipped. @@@ -144,12 -155,9 +148,11 @@@ Login and close in Nexus Repo Fetch the URL for the tagged Repo from target/checkout with - svn info - git remote -v - + git pull --prune --tags + git tag -l + git checkout <tag> + +You will be in detached mode. - 5. Prepare Voting Information and Voting @@@ -227,29 -224,28 +230,30 @@@ If no sha512 files are in the target fo - [DEPLOY DOCU](http://maven.apache.org/developers/website/deploy-component-reference-documentation.html) --Git Checkout <tagged release version> source. Generate and Publish Site ++## Git Checkout <tagged release version> source. Generate and Publish Site + +### Description of the process using asf-site branch using GIT commands + +Hint: If checking out the branch asf-site you find an .asf.yaml file, where the exact configuration is found, what happens after site generation. + +Find more information [here](https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features). - - Generate the site (mvn site, single module, mvn site site:stage multi module) -### Description of the process (GIT) + + - Generate the site (mvn site, single module, mvn site site:stage multi module) in master and optionally save it somewhere -- Git checkout branch asf-site (verify .asf.yaml has similar key/value asc +- Save target/site into another folder (target may be ignored, but to be sure) + +- checkout branch asf-site. Verify proper settings in .asf.yaml providing at least this line: whoami: asf-site - - copy content of saved copy or target/site (single module), target/staging (multi module) to *the root of the branch* -- Copy generated content to the root of the branch ++- Copy content of saved copy or target/site (single module), target/staging (multi module) to *the root of the branch* - - commit and push (this triggers the site update, if not contact INFRA) + - Commit and push (this triggers the site update, if not contact INFRA) -### Maven (may or may not be used with Git) +### ~~Maven Publishing~~ -IMPORTANT: You may have to clean up the checkoutDirectory of maven-scm-publish-plugin plugin after doing a dry run! -This directory is configured in turbine-parent bydefault outside target folder: - - turbine.site.cache: ${user.home}/turbine-sites - -But check pom.xml configuration of properties. +The second steps are not yet tested with git repos (2021). Use instead the workflow above (using GIT commands). **Multi Module**
