From 251fff5c7fd6f92c1f1acb921233c7e9c7c89003 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Wed, 18 May 2022 20:42:42 +0200 Subject: [PATCH] Prepare the repository to be hosted on SAP GitHub organisation MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- .cfignore | 2 - .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/workflows/ci.yml | 2 +- .reuse/dep5 | 29 +++++++++++++ CODE_OF_CONDUCT.md | 50 ++++++++++++---------- CONTRIBUTING.md | 38 ++++++++++++++++ LICENSE | 2 +- NOTICE | 1 - README.md | 14 ++++-- charging-stations-simulator-start.bat | 1 - charging-stations-simulator-start.sh | 2 - docker/Dockerfile | 2 +- docker/Makefile | 4 +- manifest-cf-template.yml | 2 +- package-lock.json | 6 +-- package.json | 12 +++--- sonar-project.properties | 4 +- src/scripts/deleteChargingStations.js | 2 +- src/utils/Constants.ts | 2 +- 20 files changed, 125 insertions(+), 54 deletions(-) create mode 100644 .reuse/dep5 create mode 100644 CONTRIBUTING.md delete mode 100644 NOTICE delete mode 100644 charging-stations-simulator-start.bat delete mode 100755 charging-stations-simulator-start.sh diff --git a/.cfignore b/.cfignore index 07b2979a..4f3eaa69 100644 --- a/.cfignore +++ b/.cfignore @@ -46,8 +46,6 @@ test temp outputs coverage -charging-stations-simulator-start.sh -charging-stations-simulator-start.bat node_modules sonar-project.properties performanceRecords.json diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f5fb7c3b..b4b66a12 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -22,7 +22,7 @@ body: description: Description of the bug. - type: input attributes: - label: charging-stations-simulator version + label: emobility-charging-stations-simulator version - type: input attributes: label: Node.js Version diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 75f3e08d..e0c6214d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -7,7 +7,7 @@ body: value: | Thank you for requesting a feature. - This issue tracker is for feature requests in charging-stations-simulator. + This issue tracker is for feature requests in emobility-charging-stations-simulator. - type: checkboxes attributes: diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index af014eb5..afbe84d4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -31,7 +31,7 @@ jobs: - name: npm run coverage run: npm run coverage - name: SonarCloud Scan - if: "github.repository == 'jerome-benoit/charging-stations-simulator' && matrix.node == '16.x'" + if: "github.repository == 'jerome-benoit/emobility-charging-stations-simulator' && matrix.node == '16.x'" uses: sonarsource/sonarcloud-github-action@master env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any diff --git a/.reuse/dep5 b/.reuse/dep5 new file mode 100644 index 00000000..8742d0ae --- /dev/null +++ b/.reuse/dep5 @@ -0,0 +1,29 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: emobility-charging-stations-simulator +Upstream-Contact: Jerome Benoit +Source: +Disclaimer: The code in this project may include calls to APIs ("API Calls") of + SAP or third-party products or services developed outside of this project + ("External Products"). + "APIs" means application programming interfaces, as well as their respective + specifications and implementing code that allows software to communicate with + other software. + API Calls to External Products are not licensed under the open source license + that governs this project. The use of such API Calls and related External + Products are subject to applicable additional agreements with the relevant + provider of the External Products. In no event shall the open source license + that governs this project grant any rights in or to any External Products,or + alter, expand or supersede any terms of the applicable additional agreements. + If you have a valid license agreement with SAP for the use of a particular SAP + External Product, then you may make use of any API Calls included in this + project's code for that SAP External Product, subject to the terms of such + license agreement. If you do not have a valid license agreement for the use of + a particular SAP External Product, then you may only make use of any API Calls + in this project for that SAP External Product for your internal, non-productive + and non-commercial test and evaluation of such API Calls. Nothing herein grants + you any rights to use or access any SAP External Product, or provide any third + parties the right to use of access any SAP External Product, through API Calls. + +Files: * +Copyright: 2022 SAP SE or an SAP affiliate company and contributors +License: Apache-2.0 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4bae87e2..df4ba0a7 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. @@ -22,17 +22,17 @@ community include: - Giving and gracefully accepting constructive feedback - Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -- Focusing on what is best not just for us as individuals, but for the - overall community +- Focusing on what is best not just for us as individuals, but for the overall + community Examples of unacceptable behavior include: -- The use of sexualized language or imagery, and sexual attention or - advances of any kind +- The use of sexualized language or imagery, and sexual attention or advances of + any kind - Trolling, insulting or derogatory comments, and personal or political attacks - Public or private harassment -- Publishing others' private information, such as a physical or email - address, without their explicit permission +- Publishing others' private information, such as a physical or email address, + without their explicit permission - Other conduct which could reasonably be considered inappropriate in a professional setting @@ -60,7 +60,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -jerome.benoit@piment-noir.org. +[jerome.benoit@sap.com](mailto:jerome.benoit@sap.com). All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the @@ -82,15 +82,15 @@ behavior was inappropriate. A public apology may be requested. ### 2. Warning -**Community Impact**: A violation through a single incident or series -of actions. +**Community Impact**: A violation through a single incident or series of +actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. +like social media. Violating these terms may lead to a temporary or permanent +ban. ### 3. Temporary Ban @@ -109,20 +109,24 @@ Violating these terms may lead to a permanent ban. standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. -**Consequence**: A permanent ban from any sort of public interaction within -the community. +**Consequence**: A permanent ban from any sort of public interaction within the +community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][mozilla coc]. For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. +[https://www.contributor-covenant.org/faq][faq]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[mozilla coc]: https://github.com/mozilla/diversity +[faq]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..cd108fd5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing + +## Code of Conduct + +All members of the project community must abide by the [Contributor Covenant, version 2.1](CODE_OF_CONDUCT.md). +Only by respecting each other we can develop a productive, collaborative community. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [a project maintainer](.reuse/dep5). + +## Engaging in Our Project + +We use GitHub to manage reviews of pull requests. + +- If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute) + +- Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue. + +- The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to you. If the team decides against picking up the issue, the team will post a comment with an explanation. + +## Steps to Contribute + +Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue. + +If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify. + +## Contributing Code or Documentation + +You are welcome to contribute code in order to fix a bug or to implement a new feature that is logged as an issue. + +The following rule governs code contributions: + +- Contributions must be licensed under the [Apache 2.0 License](./LICENSE) +- Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/). + +## Issues and Planning + +- We use GitHub issues to track bugs and enhancement requests. + +- Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee. diff --git a/LICENSE b/LICENSE index d6456956..79dc76f8 100644 --- a/LICENSE +++ b/LICENSE @@ -187,7 +187,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright 2020 SAP SE or an SAP affiliate company Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/NOTICE b/NOTICE deleted file mode 100644 index d3119b23..00000000 --- a/NOTICE +++ /dev/null @@ -1 +0,0 @@ -Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. diff --git a/README.md b/README.md index 849bea6f..c1940286 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator) +# [emobility-charging-stations-simulator](https://github.com/jerome-benoit/emobility-charging-stations-simulator) ## Summary @@ -365,8 +365,14 @@ All kind of OCPP parameters are supported in a charging station configuration or - _none_ -## License +## Support, Feedback, Contributing -This file and all other files in this repository are licensed under the Apache Software License, v.2 and copyrighted under the copyright in [NOTICE](NOTICE) file, except as noted otherwise in the [LICENSE](LICENSE) file or the code source file header. +This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/emobility-charging-stations-simulator/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md). -Please note that Docker images can contain other software which may be licensed under different licenses. This LICENSE and NOTICE files are also included in the Docker image. For any usage of built Docker images please make sure to check the licenses of the artifacts contained in the images. +## Code of Conduct + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times. + +## Licensing + +Copyright 2020-2022 SAP SE or an SAP affiliate company and emobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/emobility-charging-stations-simulator). diff --git a/charging-stations-simulator-start.bat b/charging-stations-simulator-start.bat deleted file mode 100644 index 0186425f..00000000 --- a/charging-stations-simulator-start.bat +++ /dev/null @@ -1 +0,0 @@ -npm start diff --git a/charging-stations-simulator-start.sh b/charging-stations-simulator-start.sh deleted file mode 100755 index d06016f4..00000000 --- a/charging-stations-simulator-start.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/usr/bin/env bash -npm start diff --git a/docker/Dockerfile b/docker/Dockerfile index 544bc00f..cb812347 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -26,7 +26,7 @@ ENV NODE_OPTIONS="--stack-trace-limit=${STACK_TRACE_LIMIT} --max-old-space-size= COPY --from=builder /usr/builder/node_modules ./node_modules COPY --from=builder /usr/builder/dist ./dist -COPY README.md NOTICE LICENSE ./ +COPY README.md LICENSE ./ COPY docker/autoconfig.sh /autoconfig.sh RUN chmod +x /autoconfig.sh diff --git a/docker/Makefile b/docker/Makefile index 422fb1fe..951fda69 100644 --- a/docker/Makefile +++ b/docker/Makefile @@ -1,9 +1,9 @@ PROJECT_NAME?=evse -NAME:=charging-stations-simulator +NAME:=emobility-charging-stations-simulator SUBMODULES_INIT?=false DOCKER_ECR_ACCOUNT_ID?=166296450311 DOCKER_ECR_REGION?=eu-west-3 -DOCKER_ECR_REGISTRY_NAME?=charging_stations_simulator +DOCKER_ECR_REGISTRY_NAME?=emobility-charging-stations-simulator DOCKER_ECR_TAG?=latest .PHONY: all diff --git a/manifest-cf-template.yml b/manifest-cf-template.yml index 222b4a4a..8a2acc2e 100644 --- a/manifest-cf-template.yml +++ b/manifest-cf-template.yml @@ -1,5 +1,5 @@ applications: - - name: charging-stations-simulator + - name: emobility-charging-stations-simulator memory: 1G disk_quota: 1G instances: 1 diff --git a/package-lock.json b/package-lock.json index 128afe67..c624562e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "charging-stations-simulator", + "name": "emobility-charging-stations-simulator", "version": "1.1.60", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "charging-stations-simulator", - "version": "1.1.59", + "name": "emobility-charging-stations-simulator", + "version": "1.1.60", "license": "Apache-2.0", "dependencies": { "@mikro-orm/core": "^5.1.3", diff --git a/package.json b/package.json index e97aedc0..b218939e 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "charging-stations-simulator", + "name": "emobility-charging-stations-simulator", "version": "1.1.60", "engines": { "node": ">=16.0.0", @@ -7,7 +7,7 @@ }, "repository": { "type": "git", - "url": "https://github.com/jerome-benoit/charging-stations-simulator.git" + "url": "https://github.com/jerome-benoit/emobility-charging-stations-simulator.git" }, "description": "Electric Vehicle charging stations simulator", "author": "SAP E-Mobility ", @@ -33,10 +33,10 @@ ] }, "auto-changelog": { - "commitUrl": "https://github.com/jerome-benoit/charging-stations-simulator/commit/{id}", - "issueUrl": "https://github.com/jerome-benoit/charging-stations-simulator/issues/{id}", - "mergeUrl": "https://github.com/jerome-benoit/charging-stations-simulator/pull/{id}", - "compareUrl": "https://github.com/jerome-benoit/charging-stations-simulator/compare/{from}...{to}" + "commitUrl": "https://github.com/jerome-benoit/emobility-charging-stations-simulator/commit/{id}", + "issueUrl": "https://github.com/jerome-benoit/emobility-charging-stations-simulator/issues/{id}", + "mergeUrl": "https://github.com/jerome-benoit/emobility-charging-stations-simulator/pull/{id}", + "compareUrl": "https://github.com/jerome-benoit/emobility-charging-stations-simulator/compare/{from}...{to}" }, "mikro-orm": { "tsConfigPath": "./tsconfig-orm.json", diff --git a/sonar-project.properties b/sonar-project.properties index 644a791a..cd5fc484 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -1,8 +1,8 @@ -sonar.projectKey=jerome-benoit_charging-stations-simulator +sonar.projectKey=jerome-benoit_emobility-charging-stations-simulator sonar.organization=jerome-benoit # This is the name and version displayed in the SonarCloud UI. -sonar.projectName=charging-stations-simulator +sonar.projectName=emobility-charging-stations-simulator sonar.projectVersion=1.0.0 # Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows. diff --git a/src/scripts/deleteChargingStations.js b/src/scripts/deleteChargingStations.js index ca5875d3..3a46893a 100755 --- a/src/scripts/deleteChargingStations.js +++ b/src/scripts/deleteChargingStations.js @@ -6,7 +6,7 @@ const fs = require('fs'); // This script deletes charging stations // Filter charging stations by id pattern -// Use Case: charging-stations-simulator creates thousands of charging stations, which are not longer needed. +// Use Case: emobility-charging-stations-simulator creates thousands of charging stations, which are not longer needed. // Delete these charging stations all at once // Config diff --git a/src/utils/Constants.ts b/src/utils/Constants.ts index 10f5ff37..efa0826f 100644 --- a/src/utils/Constants.ts +++ b/src/utils/Constants.ts @@ -112,7 +112,7 @@ export default class Constants { static readonly DEFAULT_FLUCTUATION_PERCENT = 5; static readonly DEFAULT_PERFORMANCE_RECORDS_FILENAME = 'performanceRecords.json'; - static readonly DEFAULT_PERFORMANCE_RECORDS_DB_NAME = 'charging-stations-simulator'; + static readonly DEFAULT_PERFORMANCE_RECORDS_DB_NAME = 'emobility-charging-stations-simulator'; static readonly PERFORMANCE_RECORDS_TABLE = 'performance_records'; static readonly DEFAULT_UI_WEBSOCKET_SERVER_HOST = 'localhost'; -- 2.34.1