You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by bo...@apache.org on 2021/02/10 07:24:22 UTC

[myfaces-tobago] branch tobago-4.x updated: chore(ci): update config and doc

This is an automated email from the ASF dual-hosted git repository.

bommel pushed a commit to branch tobago-4.x
in repository https://gitbox.apache.org/repos/asf/myfaces-tobago.git


The following commit(s) were added to refs/heads/tobago-4.x by this push:
     new 7e5cbd1  chore(ci): update config and doc
7e5cbd1 is described below

commit 7e5cbd11a71ca35ffe4c584a524c0e47124881b9
Author: Bernd Bohmann <bo...@apache.org>
AuthorDate: Wed Feb 10 08:13:17 2021 +0100

    chore(ci): update config and doc
---
 .github/dependabot.yml | 77 --------------------------------------------------
 CI.md                  | 37 ++++++++++++++++++++++++
 README.md              | 27 ++++++++++++++++++
 pom.xml                |  4 +--
 readme.md              | 23 ---------------
 5 files changed, 66 insertions(+), 102 deletions(-)

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
deleted file mode 100644
index 45147d8..0000000
--- a/.github/dependabot.yml
+++ /dev/null
@@ -1,77 +0,0 @@
-# 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.
-
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "maven" 
-    directory: "/" 
-    schedule:
-      interval: "daily"
-    ignore:
-      # Jetty >= 11 requires JakartaEE
-      - dependency-name: "org.eclipse.jetty:jetty-maven-plugin"
-        versions:
-          - ">= 11.0.0"
-      - dependency-name: "org.apache.myfaces.core:myfaces-api"
-        versions:
-          - ">= 3.0.0"
-      - dependency-name: "org.apache.myfaces.core:myfaces-impl"
-        versions:
-          - ">= 3.0.0"
-      - dependency-name: "org.glassfish:jakarta.faces"
-        versions:
-          - ">= 3.0.0"
-      - dependency-name: "jakarta.inject:jakarta.inject-api"
-        versions:
-          - ">= 2.0.0"
-      - dependency-name: "jakarta.servlet.jsp.jstl:jakarta.servlet.jsp.jstl-api"
-        versions:
-          - ">= 2.0.0"
-      - dependency-name: "jakarta.validation:jakarta.validation-api"
-        versions:
-          - ">= 3.0.0"
-      - dependency-name: "jakarta.el:jakarta.el-api"
-        versions:
-          - ">= 4.0.0"
-      - dependency-name: "jakarta.annotation:jakarta.annotation-api"
-        versions:
-          - ">= 2.0.0"
-      - dependency-name: "org.glassfish:jakarta.json"
-        versions:
-          - ">= 2.0.0"
-      - dependency-name: "org.jboss.weld.servlet:weld-servlet-shaded"
-        versions:
-          - ">= 4.0.0"
-      - dependency-name: "org.hibernate.validator:hibernate-validator"
-        versions:
-          - ">= 7.0.0"
-      - dependency-name: "org.antlr:stringtemplate"
-        versions:
-          - ">= 4.0.0"
-      - dependency-name: "org.apache.maven.plugins:maven-checkstyle-plugin"
-        versions:
-          - ">=3.1.0"
-      - dependency-name: "org.apache.maven.plugins:maven-enforcer-plugin"
-        versions:
-          - ">= 3.0.0"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      # Check for updates to GitHub Actions every day
-      interval: "daily"    
-
diff --git a/CI.md b/CI.md
new file mode 100644
index 0000000..2ce9b5c
--- /dev/null
+++ b/CI.md
@@ -0,0 +1,37 @@
+# Apache Tobago CI
+
+## Apache Jenkins Build Service
+
+Apache Tobago is using the Multi-Branch Pipeline Plugin for the ci builds.
+
+The Plugin is checking all branches for a `Jenkinsfile` containing the build instructions.
+
+[Jenkinsfile](Jenkinsfile)
+
+[Tobago Pipeline][1]
+
+[ASF Jenkins Build Service][2]
+
+[Multibranch Pipeline recipes][3]
+
+## Github Actions
+
+For a quick build Github Actions are configured.
+
+[.github/workflow/tobago-ci.yml](.github/workflows/tobago-ci.yml)
+
+ASF Infra has some restrictions and objections about Github Actions.
+
+[GitHub Actions and Secrets][4]
+
+[GitHub Actions status][5]
+
+[1]: https://ci-builds.apache.org/job/MyFaces/job/Tobago%20pipeline/
+
+[2]: https://cwiki.apache.org/confluence/display/INFRA/Jenkins
+
+[3]: https://cwiki.apache.org/confluence/display/INFRA/Multibranch+Pipeline+recipes
+
+[4]: https://infra.apache.org/github-actions-secrets.html
+
+[5]: https://cwiki.apache.org/confluence/display/BUILDS/GitHub+Actions+status
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..515daee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Apache Tobago
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+![Tobago CI](https://github.com/apache/myfaces-tobago/workflows/Tobago%20CI/badge.svg?branch=tobago-4.x)
+[![Build Status ASF](https://ci-builds.apache.org/buildStatus/icon?subject=ASF-Build&job=MyFaces%2FTobago+pipeline%2Ftobago-4.x)](https://ci-builds.apache.org/job/MyFaces/job/Tobago%20pipeline/job/tobago-4.x/)
+
+## Building
+
+You need Maven 3 (at least 3.0.4) and Java 8 or later to build Tobago.
+
+In the project directory you can use:
+
+```  
+mvn install  
+
+```
+
+to run the install target on all sub projects. This will
+put all necessary artifacts into your local repository.
+
+## Demo
+
+In the directory `tobago-example/tobago-example-demo` call:
+
+```
+mvn jetty:run
+```
diff --git a/pom.xml b/pom.xml
index 2070d73..87b37a5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -979,8 +979,8 @@
               <!-- sample -->
               <exclude>**/x-sample.txt</exclude>
 
-              <!-- readme -->
-              <exclude>**/readme.*</exclude>
+              <!-- md files -->
+              <exclude>**/*.md</exclude>
 
               <!-- jetty key store for testing -->
               <exclude>**/jettykeystore</exclude>
diff --git a/readme.md b/readme.md
deleted file mode 100644
index f6aba3e..0000000
--- a/readme.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# Apache Tobago
-
-## Building
-
-You need Maven 3 (at least 3.0.4) and Java 8 or later to build Tobago.
-
-In the project directory you can use:
-
-```  
-mvn install  
-
-```
-
-to run the install target on all sub projects. This will
-put all necessary artifacts into your local repository.
-
-## Demo
-
-In the directory `tobago-example/tobago-example-demo` call:
-
-```
-mvn jetty:run
-```