From 6d24a3e6fd23ef0fbd820bd5fc19fdfe244a7150 Mon Sep 17 00:00:00 2001 From: Kyle Aure Date: Mon, 6 Nov 2023 14:14:03 -0600 Subject: [PATCH 1/2] Perform some basic housekeeping Signed-off-by: Kyle Aure --- .dependabot/config.yml | 18 ------------- .github/CODEOWNERS | 6 ----- .github/dependabot.yml | 11 ++++++++ CONTRIBUTING.md | 57 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 68 insertions(+), 24 deletions(-) delete mode 100644 .dependabot/config.yml delete mode 100644 .github/CODEOWNERS create mode 100644 .github/dependabot.yml create mode 100644 CONTRIBUTING.md diff --git a/.dependabot/config.yml b/.dependabot/config.yml deleted file mode 100644 index 36387a44..00000000 --- a/.dependabot/config.yml +++ /dev/null @@ -1,18 +0,0 @@ -version: 1 - -update_configs: - - package_manager: "java:gradle" - directory: "/core" - update_schedule: "daily" - - package_manager: "java:gradle" - directory: "/modules/testcontainers" - update_schedule: "daily" - - package_manager: "java:gradle" - directory: "/modules/liberty" - update_schedule: "daily" - - package_manager: "java:gradle" - directory: "/modules/payara-micro" - update_schedule: "daily" - - package_manager: "java:gradle" - directory: "/modules/payara-server" - update_schedule: "daily" diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index 7b623dc7..00000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,6 +0,0 @@ -# Each line is a file pattern followed by one or more owners. - -# These owners will be the default reviewers for everything in -# the repo. - -* @aguibert diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..6e1172be --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: / + schedule: + interval: daily + + - package-ecosystem: gradle + directory: / + schedule: + interval: daily \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..51473616 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Contributing to MicroProfile Starter Extension for VS Code + +We welcome contributions, and request you follow these guidelines. + + - [Raising issues](#raising-issues) + - [Legal](#legal) + - [Coding Standards](#coding-standards) + - [Project Setup](#project-setup) + +### Raising issues + +Please raise any bug reports on the [issue tracker](https://github.com/MicroShed/microshed-testing/issues). Be sure to search the list to see if your issue has already been raised. + +A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue. + +### Legal + +In order to make contribution as easy as possible, we follow the same approach as the [Developer's Certificate of Origin 1.1 (DCO)](https://developercertificate.org/) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin) uses to manage code contributions. + +We simply ask that when submitting a pull request for review, the developer +must include a sign-off statement in the commit message. + +Here is an example Signed-off-by line, which indicates that the +submitter accepts the DCO: + +```text +Signed-off-by: John Doe +``` + +You can include this automatically when you commit a change to your +local git repository using the following command: + +```bash +git commit -s +``` + +### Coding Standards + +This project contains a CI build that should run successfully. +Upon opening a Pull Request or Merging a commit this build will run. +If your Pull Request results in the failure of this build it will not be reviewed or merged until the failure is fixed. + +### Project Setup + +##### Requirements + +- JDK 8 or higher +- Docker (daemon or desktop) + + +##### Building project + +Use the gradle wrapper to build this project: + +```sh +./gradlew build +``` From bae011b89b6c7573ab6d046ef83113e5d7539a63 Mon Sep 17 00:00:00 2001 From: Kyle Aure Date: Mon, 6 Nov 2023 16:40:13 -0600 Subject: [PATCH 2/2] Rename default branch to main Signed-off-by: Kyle Aure --- .github/workflows/microshed-ci.yml | 2 +- docs/features/Examples.md | 26 +++++++++---------- docs/features/KafkaMessaging.md | 2 +- docs/features/RestAssured.md | 2 +- .../testcontainers/ApplicationContainer.java | 2 +- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/workflows/microshed-ci.yml b/.github/workflows/microshed-ci.yml index 0bbb1566..a2f93097 100644 --- a/.github/workflows/microshed-ci.yml +++ b/.github/workflows/microshed-ci.yml @@ -3,7 +3,7 @@ name: MicroShed CI on: pull_request: branches: - - master + - main types: [opened, synchronize, reopened, ready_for_review] paths-ignore: - '.gitignore' diff --git a/docs/features/Examples.md b/docs/features/Examples.md index 02e80f71..798620b6 100644 --- a/docs/features/Examples.md +++ b/docs/features/Examples.md @@ -8,19 +8,19 @@ Sometimes code is worth a thousand words. Here are some pointers to working exam ## General Examples -- [Basic JAX-RS application using Gradle](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jaxrs-json) -- [Basic JAX-RS application using Maven](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/maven-app) -- [Basic JAX-RS application using REST Assured](https://github.com/MicroShed/microshed-testing/blob/master/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java) -- [JAX-RS and JDBC application using a PostgreSQL database](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jdbc-app) -- [JAX-RS application secured with Basic Auth](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jaxrs-basicauth) -- [JAX-RS application secured with MP JWT](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jaxrs-mpjwt) -- [JAX-RS and MongoDB application that depends on an external REST service](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/everything-app) -- [Application using Apache Kafka messaging](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/kafka-app) -- [Application with no Dockerfile using OpenLiberty adapter](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/liberty-app) +- [Basic JAX-RS application using Gradle](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/jaxrs-json) +- [Basic JAX-RS application using Maven](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/maven-app) +- [Basic JAX-RS application using REST Assured](https://github.com/MicroShed/microshed-testing/blob/main/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java) +- [JAX-RS and JDBC application using a PostgreSQL database](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/jdbc-app) +- [JAX-RS application secured with Basic Auth](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/jaxrs-basicauth) +- [JAX-RS application secured with MP JWT](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/jaxrs-mpjwt) +- [JAX-RS and MongoDB application that depends on an external REST service](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/everything-app) +- [Application using Apache Kafka messaging](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/kafka-app) +- [Application with no Dockerfile using OpenLiberty adapter](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/liberty-app) ## Runtime examples: -- [Testing an application with OpenLiberty](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/liberty-app) -- [Testing an application with Payara Micro](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/payara-app) -- [Testing an application with Wildfly](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/wildfly-app) -- [Testing an application with Quarkus](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/quarkus-app) +- [Testing an application with OpenLiberty](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/liberty-app) +- [Testing an application with Payara Micro](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/payara-app) +- [Testing an application with Wildfly](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/wildfly-app) +- [Testing an application with Quarkus](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/quarkus-app) diff --git a/docs/features/KafkaMessaging.md b/docs/features/KafkaMessaging.md index 86193139..e8f15587 100644 --- a/docs/features/KafkaMessaging.md +++ b/docs/features/KafkaMessaging.md @@ -85,6 +85,6 @@ injected `consumer` to the specified `topics`. ## Additional resources -- [Example application using Apache Kafka messaging](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/kafka-app) +- [Example application using Apache Kafka messaging](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/kafka-app) - [OpenLiberty blog on using MicroProfile Reactive Messaging](https://openliberty.io/blog/2019/09/13/microprofile-reactive-messaging.html) - [Quarkus guide on using Apache Kafka with Reactive Messaging](https://quarkus.io/guides/kafka) diff --git a/docs/features/RestAssured.md b/docs/features/RestAssured.md index 5ddbdeef..f15a2a50 100644 --- a/docs/features/RestAssured.md +++ b/docs/features/RestAssured.md @@ -90,7 +90,7 @@ It is also possible to send/receive POJOs with the JSON-B based ObjectMapper: } ``` -For a complete working example, see the [RestAssuredTest class](https://github.com/MicroShed/microshed-testing/blob/master/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java) +For a complete working example, see the [RestAssuredTest class](https://github.com/MicroShed/microshed-testing/blob/main/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java) ## Auto-configuration override diff --git a/modules/testcontainers/src/main/java/org/microshed/testing/testcontainers/ApplicationContainer.java b/modules/testcontainers/src/main/java/org/microshed/testing/testcontainers/ApplicationContainer.java index 905c712a..951d65d1 100644 --- a/modules/testcontainers/src/main/java/org/microshed/testing/testcontainers/ApplicationContainer.java +++ b/modules/testcontainers/src/main/java/org/microshed/testing/testcontainers/ApplicationContainer.java @@ -538,7 +538,7 @@ private String readMpRestClientConfigKey(Class restClientClass) { */ public ApplicationContainer withMpRestClient(String restClientClass, String hostUri) { // If we will be running in Docker, sanitize environment variable name using Environment Variables Mapping Rules defined in MP Config: - // https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#environment-variables-mapping-rules + // https://github.com/eclipse/microprofile-config/blob/main/spec/src/main/asciidoc/configsources.asciidoc#environment-variables-mapping-rules if (ApplicationEnvironment.Resolver.isSelected(TestcontainersConfiguration.class)) { restClientClass = restClientClass.replaceAll("[^a-zA-Z0-9_]", "_") + "_mp_rest_url"; } else {