This is an automated email from the ASF dual-hosted git repository. ningjiang pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-service-center.git
commit 15d9ce8d6cd1b2a60911ddde6b822b7a2c7b925a Author: asifdxtreme <mohammad.asif.siddiq...@huawei.com> AuthorDate: Fri Feb 23 17:45:30 2018 +0530 Add Rat Report and guide to run the RAT tool --- docs/release/Readme.md | 42 ++++ docs/release/rat-report/Rat-Report-2018-02-23.md | 266 +++++++++++++++++++++++ docs/{ => release}/releaseNotes.md | 0 3 files changed, 308 insertions(+) diff --git a/docs/release/Readme.md b/docs/release/Readme.md new file mode 100644 index 0000000..ef3775d --- /dev/null +++ b/docs/release/Readme.md @@ -0,0 +1,42 @@ +## Service-Center Release + +#### Release Notes + - [Service-Center-1.0.0-m1 Release Notes](/docs/release/releaseNotes.md) + + +#### Running Apache Rat tool +This guide will help you to run the [Apache Rat](http://creadur.apache.org/rat/index.html) tool on service-center source code. +For running the tool please follow the below guidelines. + +##### Step 1 +Clone the Servcice-Center code and download Apache Rat tool. +``` +git clone https://github.com/apache/incubator-servicecomb-service-center +``` + +``` +wget http://mirrors.hust.edu.cn/apache//creadur/apache-rat-0.12/apache-rat-0.12-bin.tar.gz + +# Untar the release +tar -xvf apache-rat-0.12-bin.tar.gz + +# Copy the jar in the root directory +cp apache-rat-0.12/apache-rat-0.12.jar ./ +``` +##### Step 2 +Run the Rat tool using the below command + +``` +java -jar apache-rat-0.12.jar -a -d incubator-servicecomb-service-center/ -e *.md *.MD .gitignore .gitmodules .travis.yml *.json *.yaml *.tmpl *.conf *.html *.pb.go services.proto manifest **vendor** +``` + +Below is the list of the files which has been excluded from the list of RAT tool. + - *.md *.MD *.html: Skip all the Readme and Documentation file like Api Docs. + - .gitignore .gitmodules .travis.yml : Skip the git files and travis file. + - *.json *.yaml *.tmpl *.conf : Skip all the json files , yaml files, temp DockerFile and configuration files. + - *.pb.go services.proto : Skip the Protobuf auto-generated codes. + - manifest **vendor : Skip manifest and all the files under vendor. + +You can access the latest RAT report [here](/docs/release/rat-report) + + \ No newline at end of file diff --git a/docs/release/rat-report/Rat-Report-2018-02-23.md b/docs/release/rat-report/Rat-Report-2018-02-23.md new file mode 100644 index 0000000..7bc6aae --- /dev/null +++ b/docs/release/rat-report/Rat-Report-2018-02-23.md @@ -0,0 +1,266 @@ +``` +***************************************************** +Summary +------- +Generated at: 2018-02-23T19:40:21+08:00 + +Notes: 3 +Binaries: 9 +Archives: 0 +Standards: 227 + +Apache Licensed: 227 +Generated Documents: 0 + +JavaDocs are generated, thus a license header is optional. +Generated files do not require license headers. + +0 Unknown Licenses + +***************************************************** + Files with Apache License headers will be marked AL + Binary files (which do not require any license headers) will be marked B + Compressed archives will be marked A + Notices, licenses etc. will be marked N + N incubator-servicecomb-service-center/DISCLAIMER + N incubator-servicecomb-service-center/LICENSE + N incubator-servicecomb-service-center/NOTICE + AL incubator-servicecomb-service-center/main.go + B incubator-servicecomb-service-center/docs/Service-Center-UI-Preview.gif + B incubator-servicecomb-service-center/docs/communication.PNG + B incubator-servicecomb-service-center/docs/onStartup.PNG + B incubator-servicecomb-service-center/docs/tracing-file.PNG + B incubator-servicecomb-service-center/docs/tracing-server.PNG + AL incubator-servicecomb-service-center/examples/service_center/request/add_dependecy.sh + AL incubator-servicecomb-service-center/examples/service_center/request/create_service.sh + AL incubator-servicecomb-service-center/examples/service_center/request/delete_instance.sh + AL incubator-servicecomb-service-center/examples/service_center/request/delete_service.sh + AL incubator-servicecomb-service-center/examples/service_center/request/get_consumers.sh + AL incubator-servicecomb-service-center/examples/service_center/request/get_providers.sh + AL incubator-servicecomb-service-center/examples/service_center/request/get_service.sh + AL incubator-servicecomb-service-center/examples/service_center/request/heartbeat.sh + AL incubator-servicecomb-service-center/examples/service_center/request/register_intance_json.sh + AL incubator-servicecomb-service-center/examples/service_center/request/update_properties.sh + AL incubator-servicecomb-service-center/examples/service_center/request/update_status.sh + AL incubator-servicecomb-service-center/frontend/main.go + B incubator-servicecomb-service-center/frontend/app/favicon.ico + AL incubator-servicecomb-service-center/frontend/app/apiList/apiList.js + B incubator-servicecomb-service-center/frontend/app/images/loader.gif + B incubator-servicecomb-service-center/frontend/app/images/sc.png + B incubator-servicecomb-service-center/frontend/app/images/yeoman.png + AL incubator-servicecomb-service-center/frontend/app/scripts/app.js + AL incubator-servicecomb-service-center/frontend/app/scripts/scRouterConfig.js + AL incubator-servicecomb-service-center/frontend/app/scripts/controllers/serviceCenterCtrl.js + AL incubator-servicecomb-service-center/frontend/app/scripts/directives/nodataFoundDirective.js + AL incubator-servicecomb-service-center/frontend/app/scripts/directives/tableDirective.js + AL incubator-servicecomb-service-center/frontend/app/scripts/languages/locale-cz.js + AL incubator-servicecomb-service-center/frontend/app/scripts/languages/locale-en.js + AL incubator-servicecomb-service-center/frontend/app/scripts/modules/dashboard/controllers/dashboardCtrl.js + AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/schemaCtrl.js + AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/serviceInfoCtrl.js + AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/servicesListCtrl.js + AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/filters/formatSchema.js + AL incubator-servicecomb-service-center/frontend/app/scripts/services/commonService.js + AL incubator-servicecomb-service-center/frontend/app/scripts/services/httpService.js + AL incubator-servicecomb-service-center/frontend/app/styles/main.css + AL incubator-servicecomb-service-center/frontend/schema/schemahandler.go + AL incubator-servicecomb-service-center/integration/apis.go + AL incubator-servicecomb-service-center/integration/governance_test.go + AL incubator-servicecomb-service-center/integration/health_test.go + AL incubator-servicecomb-service-center/integration/instances_test.go + AL incubator-servicecomb-service-center/integration/integrationtest_suite_test.go + AL incubator-servicecomb-service-center/integration/microservices_test.go + AL incubator-servicecomb-service-center/integration/rules_test.go + AL incubator-servicecomb-service-center/integration/schema_test.go + AL incubator-servicecomb-service-center/integration/tags_test.go + AL incubator-servicecomb-service-center/pkg/async/async_task.go + AL incubator-servicecomb-service-center/pkg/async/async_task_test.go + AL incubator-servicecomb-service-center/pkg/chain/callback.go + AL incubator-servicecomb-service-center/pkg/chain/chain.go + AL incubator-servicecomb-service-center/pkg/chain/chain_test.go + AL incubator-servicecomb-service-center/pkg/chain/handler.go + AL incubator-servicecomb-service-center/pkg/chain/invocation.go + AL incubator-servicecomb-service-center/pkg/errors/error.go + AL incubator-servicecomb-service-center/pkg/etcdsync/etcdsync_suite_test.go + AL incubator-servicecomb-service-center/pkg/etcdsync/mutex.go + AL incubator-servicecomb-service-center/pkg/etcdsync/mutex_test.go + AL incubator-servicecomb-service-center/pkg/grace/grace.go + AL incubator-servicecomb-service-center/pkg/plugin/loader.go + AL incubator-servicecomb-service-center/pkg/plugin/loader_test.go + AL incubator-servicecomb-service-center/pkg/rest/client.go + AL incubator-servicecomb-service-center/pkg/rest/common.go + AL incubator-servicecomb-service-center/pkg/rest/conn.go + AL incubator-servicecomb-service-center/pkg/rest/listener.go + AL incubator-servicecomb-service-center/pkg/rest/roa.go + AL incubator-servicecomb-service-center/pkg/rest/route.go + AL incubator-servicecomb-service-center/pkg/rest/server.go + AL incubator-servicecomb-service-center/pkg/rpc/grpc.go + AL incubator-servicecomb-service-center/pkg/tlsutil/tlsutil.go + AL incubator-servicecomb-service-center/pkg/util/concurrent_map.go + AL incubator-servicecomb-service-center/pkg/util/concurrent_map_test.go + AL incubator-servicecomb-service-center/pkg/util/context.go + AL incubator-servicecomb-service-center/pkg/util/goroutines.go + AL incubator-servicecomb-service-center/pkg/util/goroutines_test.go + AL incubator-servicecomb-service-center/pkg/util/log.go + AL incubator-servicecomb-service-center/pkg/util/log_test.go + AL incubator-servicecomb-service-center/pkg/util/logrotate.go + AL incubator-servicecomb-service-center/pkg/util/metric.go + AL incubator-servicecomb-service-center/pkg/util/net.go + AL incubator-servicecomb-service-center/pkg/util/net_test.go + AL incubator-servicecomb-service-center/pkg/util/reflect.go + AL incubator-servicecomb-service-center/pkg/util/reflect_test.go + AL incubator-servicecomb-service-center/pkg/util/sys.go + AL incubator-servicecomb-service-center/pkg/util/tree.go + AL incubator-servicecomb-service-center/pkg/util/tree_test.go + AL incubator-servicecomb-service-center/pkg/util/uniqueue.go + AL incubator-servicecomb-service-center/pkg/util/uniqueue_test.go + AL incubator-servicecomb-service-center/pkg/util/util.go + AL incubator-servicecomb-service-center/pkg/util/util_test.go + AL incubator-servicecomb-service-center/pkg/util/uuid.go + AL incubator-servicecomb-service-center/pkg/validate/url.go + AL incubator-servicecomb-service-center/pkg/validate/validate.go + AL incubator-servicecomb-service-center/scripts/create_gvt_manifest(exp).sh + AL incubator-servicecomb-service-center/scripts/integration_test.sh + AL incubator-servicecomb-service-center/scripts/prepare_env_ut.sh + AL incubator-servicecomb-service-center/scripts/ut.sh + AL incubator-servicecomb-service-center/scripts/ut_test_in_docker.sh + AL incubator-servicecomb-service-center/scripts/docker/build-frontend-image/build.sh + AL incubator-servicecomb-service-center/scripts/docker/build-image/build.sh + AL incubator-servicecomb-service-center/scripts/docker/build-image/start.sh + AL incubator-servicecomb-service-center/scripts/frontend/start_linux.sh + AL incubator-servicecomb-service-center/scripts/frontend/start_windows.bat + AL incubator-servicecomb-service-center/scripts/release/make_frontend_release.sh + AL incubator-servicecomb-service-center/scripts/release/make_release.sh + AL incubator-servicecomb-service-center/server/api.go + AL incubator-servicecomb-service-center/server/server.go + AL incubator-servicecomb-service-center/server/bootstrap/bootstrap.go + AL incubator-servicecomb-service-center/server/core/0_init.go + AL incubator-servicecomb-service-center/server/core/common.go + AL incubator-servicecomb-service-center/server/core/info.go + AL incubator-servicecomb-service-center/server/core/key_generator.go + AL incubator-servicecomb-service-center/server/core/microservice.go + AL incubator-servicecomb-service-center/server/core/backend/backend.go + AL incubator-servicecomb-service-center/server/core/backend/store/async.go + AL incubator-servicecomb-service-center/server/core/backend/store/cacher.go + AL incubator-servicecomb-service-center/server/core/backend/store/defer.go + AL incubator-servicecomb-service-center/server/core/backend/store/defer_test.go + AL incubator-servicecomb-service-center/server/core/backend/store/event.go + AL incubator-servicecomb-service-center/server/core/backend/store/indexer.go + AL incubator-servicecomb-service-center/server/core/backend/store/lease.go + AL incubator-servicecomb-service-center/server/core/backend/store/listwatch.go + AL incubator-servicecomb-service-center/server/core/backend/store/opt.go + AL incubator-servicecomb-service-center/server/core/backend/store/store.go + AL incubator-servicecomb-service-center/server/core/proto/services.go + AL incubator-servicecomb-service-center/server/error/error.go + AL incubator-servicecomb-service-center/server/govern/controller_v3.go + AL incubator-servicecomb-service-center/server/govern/controller_v4.go + AL incubator-servicecomb-service-center/server/govern/govern.go + AL incubator-servicecomb-service-center/server/govern/govern_suite_test.go + AL incubator-servicecomb-service-center/server/govern/service.go + AL incubator-servicecomb-service-center/server/govern/service_test.go + AL incubator-servicecomb-service-center/server/handler/auth/auth.go + AL incubator-servicecomb-service-center/server/handler/cache/cache.go + AL incubator-servicecomb-service-center/server/handler/context/context.go + AL incubator-servicecomb-service-center/server/handler/context/v3.go + AL incubator-servicecomb-service-center/server/handler/context/v4.go + AL incubator-servicecomb-service-center/server/handler/metric/metric.go + AL incubator-servicecomb-service-center/server/handler/tracing/tracing.go + AL incubator-servicecomb-service-center/server/infra/auditlog/auditlog.go + AL incubator-servicecomb-service-center/server/infra/auth/auth.go + AL incubator-servicecomb-service-center/server/infra/quota/quota.go + AL incubator-servicecomb-service-center/server/infra/registry/registry.go + AL incubator-servicecomb-service-center/server/infra/security/cipher.go + AL incubator-servicecomb-service-center/server/infra/tracing/tracing.go + AL incubator-servicecomb-service-center/server/infra/uuid/uuid.go + AL incubator-servicecomb-service-center/server/interceptor/interceptors.go + AL incubator-servicecomb-service-center/server/interceptor/access/access.go + AL incubator-servicecomb-service-center/server/interceptor/cors/cors.go + AL incubator-servicecomb-service-center/server/mux/mux.go + AL incubator-servicecomb-service-center/server/plugin/plugin.go + AL incubator-servicecomb-service-center/server/plugin/infra/auth/buildin/buildin.go + AL incubator-servicecomb-service-center/server/plugin/infra/quota/buildin/buildin.go + AL incubator-servicecomb-service-center/server/plugin/infra/quota/unlimit/unlimit.go + AL incubator-servicecomb-service-center/server/plugin/infra/registry/buildin/buildin.go + AL incubator-servicecomb-service-center/server/plugin/infra/registry/embededetcd/embededetcd.go + AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/etcd.go + AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/tracing.go + AL incubator-servicecomb-service-center/server/plugin/infra/security/buildin/buildin.go + AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/buildin.go + AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/common.go + AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/file_collector.go + AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/span.go + AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/span_test.go + AL incubator-servicecomb-service-center/server/plugin/infra/uuid/buildin/buildin.go + AL incubator-servicecomb-service-center/server/rest/handler.go + AL incubator-servicecomb-service-center/server/rest/metric.go + AL incubator-servicecomb-service-center/server/rest/server.go + AL incubator-servicecomb-service-center/server/rest/controller/rest_util.go + AL incubator-servicecomb-service-center/server/rest/controller/v3/dependency_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v3/instance_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v3/instance_watcher.go + AL incubator-servicecomb-service-center/server/rest/controller/v3/main_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v3/microservice_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v3/query_rule_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v3/schema_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v3/tag_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v3/v3.go + AL incubator-servicecomb-service-center/server/rest/controller/v4/dependency_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v4/instance_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v4/instance_watcher.go + AL incubator-servicecomb-service-center/server/rest/controller/v4/main_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v4/microservice_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v4/query_rule_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v4/schema_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v4/tag_controller.go + AL incubator-servicecomb-service-center/server/rest/controller/v4/v4.go + AL incubator-servicecomb-service-center/server/rpc/server.go + AL incubator-servicecomb-service-center/server/service/concurrent_test.go + AL incubator-servicecomb-service-center/server/service/instances.go + AL incubator-servicecomb-service-center/server/service/instances_test.go + AL incubator-servicecomb-service-center/server/service/microservices.go + AL incubator-servicecomb-service-center/server/service/microservices_test.go + AL incubator-servicecomb-service-center/server/service/resource_assembler.go + AL incubator-servicecomb-service-center/server/service/rule.go + AL incubator-servicecomb-service-center/server/service/rule_test.go + AL incubator-servicecomb-service-center/server/service/schema.go + AL incubator-servicecomb-service-center/server/service/schema_test.go + AL incubator-servicecomb-service-center/server/service/service_dependency.go + AL incubator-servicecomb-service-center/server/service/service_dependency_test.go + AL incubator-servicecomb-service-center/server/service/service_suite_test.go + AL incubator-servicecomb-service-center/server/service/tag.go + AL incubator-servicecomb-service-center/server/service/tag_test.go + AL incubator-servicecomb-service-center/server/service/event/dependency_event_handler.go + AL incubator-servicecomb-service-center/server/service/event/event.go + AL incubator-servicecomb-service-center/server/service/event/instance_event_handler.go + AL incubator-servicecomb-service-center/server/service/event/rule_event_handler.go + AL incubator-servicecomb-service-center/server/service/event/service_event_handler.go + AL incubator-servicecomb-service-center/server/service/event/tag_event_handler.go + AL incubator-servicecomb-service-center/server/service/notification/listwatcher.go + AL incubator-servicecomb-service-center/server/service/notification/notification_healthchecker.go + AL incubator-servicecomb-service-center/server/service/notification/notification_service.go + AL incubator-servicecomb-service-center/server/service/notification/struct.go + AL incubator-servicecomb-service-center/server/service/notification/watch_util.go + AL incubator-servicecomb-service-center/server/service/util/dependency.go + AL incubator-servicecomb-service-center/server/service/util/dependency_test.go + AL incubator-servicecomb-service-center/server/service/util/domain_util.go + AL incubator-servicecomb-service-center/server/service/util/domain_util_test.go + AL incubator-servicecomb-service-center/server/service/util/heartbeat_util.go + AL incubator-servicecomb-service-center/server/service/util/heartbeat_util_test.go + AL incubator-servicecomb-service-center/server/service/util/instance_util.go + AL incubator-servicecomb-service-center/server/service/util/instance_util_test.go + AL incubator-servicecomb-service-center/server/service/util/microservice_util.go + AL incubator-servicecomb-service-center/server/service/util/rule_util.go + AL incubator-servicecomb-service-center/server/service/util/rule_util_test.go + AL incubator-servicecomb-service-center/server/service/util/schema_util.go + AL incubator-servicecomb-service-center/server/service/util/schema_util_test.go + AL incubator-servicecomb-service-center/server/service/util/tag_util.go + AL incubator-servicecomb-service-center/server/service/util/tag_util_test.go + AL incubator-servicecomb-service-center/server/service/util/util.go + AL incubator-servicecomb-service-center/server/service/util/util_suite_test.go + AL incubator-servicecomb-service-center/server/service/util/versionrule.go + AL incubator-servicecomb-service-center/server/service/util/versionrule_test.go + AL incubator-servicecomb-service-center/server/tls/tls.go + AL incubator-servicecomb-service-center/version/version.go + +***************************************************** +``` \ No newline at end of file diff --git a/docs/releaseNotes.md b/docs/release/releaseNotes.md similarity index 100% rename from docs/releaseNotes.md rename to docs/release/releaseNotes.md -- To stop receiving notification emails like this one, please contact ningji...@apache.org.