Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propose ADR for restructuring Quarkus workshops organization #44351

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

cescoffier
Copy link
Member

  • Suggests moving from a single repository to individual repositories per workshop
  • Aims to simplify management, improve discoverability, and enable GitHub Pages for documentation
  • Addresses limitations of current structure in hosting and maintaining multiple workshops

Copy link
Member

@emmanuelbernard emmanuelbernard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comment but LGTM otherwise.

adr/0007-quarkus-workshop-structure.adoc Outdated Show resolved Hide resolved
@edeandrea
Copy link
Contributor

I'm not sure if this is currently (or will be) something to consider, but hosting these in the quarkusio org will place some limitations on available CI resources. We want to be sure these repos are "good citizens" and aren't stealing resources away from the main quarkus repo.

@cescoffier
Copy link
Member Author

@edeandrea I added a point in the Negative Consequences section.

@cescoffier cescoffier marked this pull request as ready for review November 6, 2024 17:27
@holly-cummins
Copy link
Contributor

holly-cummins commented Nov 6, 2024

I think we should cross-link to the related issue, quarkusio/quarkus-workshops#548. (Which I have now done. :) )


* Lack of a central place to list all workshops. This could be mitigated by creating a dedicated page on the Quarkus website.
* Potential CI resource shortage as each workshop repository uses _quarkusio_ organization CI resources.
However, this is unlikely to be a significant issue, as, generally, workshops don't use much CI resources.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, if you are going to have tests in your workshop that can run so that versions stay up to date, then this might start to become true....

Copy link
Member

@maxandersen maxandersen Nov 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if these does start take significant resources we can move them to a new org.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, but let's tackle one problem at a time. Moving them to a separate organization also has downsides.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The superheroes workshop takes more CI resources, than you'd think, because of the combinatorics. It's currently about 2.5h machine time per CI run. But I think that shouldn't affect the org decision unless we start to see an impact elsewhere in the org.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cescoffier if it was unclear - I was just stating that if it becomes a problem it is fairly easy to move individual repos somewhere else. so we agree..

though 2.5hrs feels crazy ....what is that build doing ;)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... because having them in a separate org would be letting the tail wag the dog, and sacrificing discoverability to accommodate a technical limitation of GitHub runners.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

though 2.5hrs feels crazy ....what is that build doing ;)

It's a static site that needs to host variations for each OS, each combination of features, etc (for example, a workshop host could share the URL https://quarkus.io/quarkus-workshops/super-heroes/variants/os-all-ai-false-azure-false-cli-false-container-false-contract-testing-true-extension-false-kubernetes-false-messaging-true-native-false-observability-false/spine.html with their participants). So it builds each variation, and the combinatorics multiply exponentially.The alternative is to generate dynamically, but that means standing up a back end and move away from GitHub pages, but that has a lot of downside.

- Suggests moving from a single repository to individual repositories per workshop
- Aims to simplify management, improve discoverability, and enable GitHub Pages for documentation
- Addresses limitations of current structure in hosting and maintaining multiple workshops
@cescoffier cescoffier merged commit 7a6b0ee into quarkusio:main Nov 11, 2024
3 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.17 - main milestone Nov 11, 2024
DeMol-EE added a commit to DeMol-EE/quarkus that referenced this pull request Nov 12, 2024
commit d1394b6
Merge: 52ebb92 c41dfd6
Author: RobinDM <[email protected]>
Date:   Tue Nov 12 08:56:25 2024 +0100

    Merge branch 'quarkusio:main' into datasource-devservices-showLogs-squashed

commit c41dfd6
Merge: 52286bf 0611099
Author: Georgios Andrianakis <[email protected]>
Date:   Tue Nov 12 09:32:18 2024 +0200

    Merge pull request quarkusio#44431 from phillip-kruger/filename-openapi

    Add option to name stored openapi files

commit 52286bf
Merge: 81679eb 5a2d46c
Author: Georgios Andrianakis <[email protected]>
Date:   Tue Nov 12 08:08:49 2024 +0200

    Merge pull request quarkusio#44299 from Sgitario/41689_good

    REST Server/Client allows configuring the removal of trailing slashs

commit 52ebb92
Merge: 0348db6 81679eb
Author: RobinDM <[email protected]>
Date:   Tue Nov 12 06:59:08 2024 +0100

    Merge branch 'main' into datasource-devservices-showLogs-squashed

commit 0348db6
Author: RobinDM <[email protected]>
Date:   Tue Nov 12 06:58:50 2024 +0100

    Update extensions/datasource/runtime/src/main/java/io/quarkus/datasource/runtime/DevServicesBuildTimeConfig.java

    Co-authored-by: George Gastaldi <[email protected]>

commit 81679eb
Merge: 10ed7b1 0878a19
Author: George Gastaldi <[email protected]>
Date:   Tue Nov 12 00:10:40 2024 -0300

    Merge pull request quarkusio#44415 from radcortez/quarkus-44400

    Propagate Runtime properties in JBang Dev mode

commit 0611099
Author: Phillip Kruger <[email protected]>
Date:   Tue Nov 12 13:54:41 2024 +1100

    Add option to name stored openapi files

    Signed-off-by: Phillip Kruger <[email protected]>

commit 10ed7b1
Merge: 6329fda f23faa2
Author: Georgios Andrianakis <[email protected]>
Date:   Mon Nov 11 19:53:21 2024 +0200

    Merge pull request quarkusio#44421 from mariofusco/q44417

    Fix deserialization of null maps in reflection-free Jackson deserializers

commit 6329fda
Merge: e7fb440 8ce3dc5
Author: Andy Damevin <[email protected]>
Date:   Mon Nov 11 18:36:35 2024 +0100

    Merge pull request quarkusio#44416 from mkouba/issue-44412

    QuteErrorPageSetup: support templates that are not backed by a file

commit e7fb440
Merge: 7a6b0ee 95fea0b
Author: Bruno Baptista <[email protected]>
Date:   Mon Nov 11 16:48:59 2024 +0000

    Merge pull request quarkusio#43983 from alesj/simplespanprocessor_i29448

    Add SimpleSpanProcessor support

commit f23faa2
Author: mariofusco <[email protected]>
Date:   Mon Nov 11 17:47:29 2024 +0100

    Fix deserialization of null maps in reflection-free Jackson deserializers

commit 8ce3dc5
Author: Martin Kouba <[email protected]>
Date:   Mon Nov 11 14:56:20 2024 +0100

    QuteErrorPageSetup: support templates that are not backed by a file

    - fixes quarkusio#44412

commit 0878a19
Author: Roberto Cortez <[email protected]>
Date:   Mon Nov 11 13:37:42 2024 +0000

    Propagate Runtime properties in JBang Dev mode

commit 95fea0b
Author: Ales Justin <[email protected]>
Date:   Thu Oct 17 12:50:53 2024 +0200

    Add SimpleSpanProcessor support

commit 7a6b0ee
Merge: ddee2e0 686cc7d
Author: Clement Escoffier <[email protected]>
Date:   Mon Nov 11 09:03:11 2024 +0100

    Merge pull request quarkusio#44351 from cescoffier/workshop-structure-adr

    Propose ADR for restructuring Quarkus workshops organization

commit 686cc7d
Author: Clement Escoffier <[email protected]>
Date:   Wed Nov 6 16:28:07 2024 +0100

    Propose ADR for restructuring Quarkus workshops organization

    - Suggests moving from a single repository to individual repositories per workshop
    - Aims to simplify management, improve discoverability, and enable GitHub Pages for documentation
    - Addresses limitations of current structure in hosting and maintaining multiple workshops

commit ddee2e0
Merge: b3d5937 2ffe012
Author: Martin Kouba <[email protected]>
Date:   Mon Nov 11 08:48:15 2024 +0100

    Merge pull request quarkusio#44224 from mkouba/issue-44048

    Quartz: introduce Nonconcurrent

commit b3d5937
Merge: b5a1eac bd03e6c
Author: Phillip Krüger <[email protected]>
Date:   Mon Nov 11 09:28:20 2024 +1100

    Merge pull request quarkusio#44407 from michalvavrik/feature/add-roles-allowed-vals-to-openapi

    Include allowed roles in security scheme scopes when OpenApi version is 3.1.0 or greater

commit bd03e6c
Author: Michal Vavřík <[email protected]>
Date:   Sun Nov 10 12:57:36 2024 +0100

    Include allowed roles in security scheme scopes in OpenApi 3.1+

commit b5a1eac
Merge: 0782ecc 998c3ee
Author: Sergey Beryozkin <[email protected]>
Date:   Sun Nov 10 11:23:33 2024 +0000

    Merge pull request quarkusio#44406 from michalvavrik/feature/handle-oidc-extension-deprecations

    Handle InjectionPointsTransformer deprecations in OIDC extension

commit 998c3ee
Author: Michal Vavřík <[email protected]>
Date:   Sun Nov 10 10:39:10 2024 +0100

    Handle InjectionPointsTransformer deprecations in OIDC extension

commit 0782ecc
Merge: 1e2140d e5a21e4
Author: Georgios Andrianakis <[email protected]>
Date:   Sat Nov 9 19:28:37 2024 +0200

    Merge pull request quarkusio#44273 from Vinche59/kubernetest-nodeSelector-without-dekorate-bump

    Add nodeSelector capability to kubernetes extension

commit e5a21e4
Author: Vincent Sourin <[email protected]>
Date:   Sun Oct 27 13:31:27 2024 +0100

    Add nodeSelect capability to kubernetes extension.

    Fix quarkusio#44122

    Signed-off-by: Vinche <[email protected]>

commit 1e2140d
Merge: 00f271c 48d8fb7
Author: Guillaume Smet <[email protected]>
Date:   Sat Nov 9 16:53:01 2024 +0100

    Merge pull request quarkusio#44394 from quarkusio/dependabot/maven/io.quarkus.bot-build-reporter-maven-extension-3.9.6

    Bump io.quarkus.bot:build-reporter-maven-extension from 3.9.5 to 3.9.6

commit 00f271c
Merge: ee2100b 9361944
Author: Guillaume Smet <[email protected]>
Date:   Sat Nov 9 16:52:27 2024 +0100

    Merge pull request quarkusio#44396 from quarkusio/dependabot/maven/org.apache.groovy-groovy-4.0.24

    Bump org.apache.groovy:groovy from 4.0.23 to 4.0.24

commit ee2100b
Merge: 3321050 f983e20
Author: Sergey Beryozkin <[email protected]>
Date:   Sat Nov 9 12:17:00 2024 +0000

    Merge pull request quarkusio#44389 from michalvavrik/feature/kc-dev-svc-for-kc-admin-client

    Start Keycloak Dev Services for standalone Keycloak Admin REST/RESTEasy clients

commit 3321050
Merge: 76cba8c 3f10b51
Author: Sergey Beryozkin <[email protected]>
Date:   Sat Nov 9 11:29:52 2024 +0000

    Merge pull request quarkusio#44374 from sberyozkin/optimize_oidc_tenants_grouping

    Improve the way OIDC tenants are grouped and their properties are generated

commit 76cba8c
Merge: 4221467 af78f41
Author: Sergey Beryozkin <[email protected]>
Date:   Sat Nov 9 11:28:55 2024 +0000

    Merge pull request quarkusio#44397 from quarkusio/dependabot/maven/com.nimbusds-nimbus-jose-jwt-9.46

    Bump com.nimbusds:nimbus-jose-jwt from 9.45 to 9.46

commit 4221467
Merge: 81d5343 bfb59fc
Author: George Gastaldi <[email protected]>
Date:   Fri Nov 8 21:27:01 2024 -0300

    Merge pull request quarkusio#44398 from sberyozkin/keycloak_devservice_prop_doc_typo

    Fix Keycloak DevService property doc typo

commit bfb59fc
Author: Sergey Beryozkin <[email protected]>
Date:   Fri Nov 8 23:18:02 2024 +0000

    Fix Keycloak DevService property doc typo

commit af78f41
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Fri Nov 8 22:28:30 2024 +0000

    Bump com.nimbusds:nimbus-jose-jwt from 9.45 to 9.46

    Bumps [com.nimbusds:nimbus-jose-jwt](https://bitbucket.org/connect2id/nimbus-jose-jwt) from 9.45 to 9.46.
    - [Changelog](https://bitbucket.org/connect2id/nimbus-jose-jwt/src/master/CHANGELOG.txt)
    - [Commits](https://bitbucket.org/connect2id/nimbus-jose-jwt/branches/compare/9.46..9.45)

    ---
    updated-dependencies:
    - dependency-name: com.nimbusds:nimbus-jose-jwt
      dependency-type: direct:production
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <[email protected]>

commit 9361944
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Fri Nov 8 22:27:26 2024 +0000

    Bump org.apache.groovy:groovy from 4.0.23 to 4.0.24

    Bumps [org.apache.groovy:groovy](https://github.com/apache/groovy) from 4.0.23 to 4.0.24.
    - [Commits](https://github.com/apache/groovy/commits)

    ---
    updated-dependencies:
    - dependency-name: org.apache.groovy:groovy
      dependency-type: direct:production
      update-type: version-update:semver-patch
    ...

    Signed-off-by: dependabot[bot] <[email protected]>

commit 48d8fb7
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Fri Nov 8 22:24:14 2024 +0000

    Bump io.quarkus.bot:build-reporter-maven-extension from 3.9.5 to 3.9.6

    Bumps [io.quarkus.bot:build-reporter-maven-extension](https://github.com/quarkusio/build-reporter) from 3.9.5 to 3.9.6.
    - [Commits](quarkusio/build-reporter@3.9.5...3.9.6)

    ---
    updated-dependencies:
    - dependency-name: io.quarkus.bot:build-reporter-maven-extension
      dependency-type: direct:production
      update-type: version-update:semver-patch
    ...

    Signed-off-by: dependabot[bot] <[email protected]>

commit 3f10b51
Author: Sergey Beryozkin <[email protected]>
Date:   Thu Nov 7 19:12:09 2024 +0000

    Improve the way OIDC tenants are grouped and their properties are generated

commit 81d5343
Merge: 901675f a4d7e2f
Author: Guillaume Smet <[email protected]>
Date:   Fri Nov 8 22:26:14 2024 +0100

    Merge pull request quarkusio#44390 from gsmet/better-deployment-detection

    Fix runtime/deployment detection and propagate it

commit 901675f
Merge: d1c3ae8 3d110d1
Author: Clement Escoffier <[email protected]>
Date:   Fri Nov 8 19:34:29 2024 +0100

    Merge pull request quarkusio#43232 from troosan/quarkusio#23127

    Add support for Socket Logging Handler with basic ECS format logging

commit d1c3ae8
Merge: 7603085 1813c5a
Author: Sergey Beryozkin <[email protected]>
Date:   Fri Nov 8 17:33:42 2024 +0000

    Merge pull request quarkusio#44388 from gsmet/fix-config-generation

    Fix some invalid configuration cases for doc generation and fail the build if some description are missing

commit 7603085
Merge: 30d733f 77747da
Author: Georgios Andrianakis <[email protected]>
Date:   Fri Nov 8 17:37:21 2024 +0200

    Merge pull request quarkusio#44373 from geoand/quarkusio#44231

    Ensure that custom Jackson modules work in dev-mode

commit a4d7e2f
Author: Guillaume Smet <[email protected]>
Date:   Fri Nov 8 15:46:23 2024 +0100

    Fix runtime/deployment detection and propagate it

    That way, we can assert if the module is a deployment module later in
    the process.

    Related to quarkusio#43513

commit f983e20
Author: Michal Vavřík <[email protected]>
Date:   Fri Nov 8 16:06:21 2024 +0100

    Start Keycloak Dev Svc for standalone KC Admin client

commit 1813c5a
Author: Guillaume Smet <[email protected]>
Date:   Fri Nov 8 14:47:20 2024 +0100

    Generate a report for missing Javadoc and fail the build if not empty

commit bab4a5a
Author: Guillaume Smet <[email protected]>
Date:   Fri Nov 8 14:46:20 2024 +0100

    Fix some invalid configuration cases

    TransactionManagerConfiguration was just plain weird so fixed it.
    For the others, we need to mark the interfaces as being config or we
    won't generate the Javadoc for them.

commit 30d733f
Merge: 5be2257 959a2e1
Author: Martin Kouba <[email protected]>
Date:   Fri Nov 8 11:28:14 2024 +0100

    Merge pull request quarkusio#44385 from mkouba/issue-44366

    Qute: fix generation of qute-i18n-examples

commit 77747da
Author: Georgios Andrianakis <[email protected]>
Date:   Thu Nov 7 20:22:31 2024 +0200

    Ensure that custom Jackson modules work in dev-mode

    Fixes: quarkusio#44231

commit 959a2e1
Author: Martin Kouba <[email protected]>
Date:   Fri Nov 8 08:43:36 2024 +0100

    Qute: fix generation of qute-i18n-examples

    - handle localized enums correctly
    - fixes quarkusio#44366

commit 611f5e0
Author: Robin De Mol <[email protected]>
Date:   Thu Nov 7 22:04:13 2024 +0100

    datasource devservices: showLogs

    Brings support for JBossLoggingConsumer to container-based datasource
    dev services, and adds a little section to the documentation about the
    new "showLogs" option.

    Also contains a minor correction to the AppCDS documentation.

commit 5be2257
Merge: 9761a6e b0339bd
Author: Georgios Andrianakis <[email protected]>
Date:   Fri Nov 8 08:25:50 2024 +0200

    Merge pull request quarkusio#44377 from quarkusio/dependabot/maven/flyway.version-10.21.0

    Bump flyway.version from 10.20.1 to 10.21.0

commit 9761a6e
Merge: 5810fca dd2201e
Author: Georgios Andrianakis <[email protected]>
Date:   Fri Nov 8 08:16:56 2024 +0200

    Merge pull request quarkusio#44376 from dmlloyd/log-docs

    Clarify logging rotation docs a little bit

commit 5a2d46c
Author: Roberto Cortez <[email protected]>
Date:   Wed Nov 6 12:02:09 2024 +0000

    Avoid possible concurrency issues with RestClientsConfig.RestClientKeysProvider.KEYS in build time

commit 606143b
Author: Jose <[email protected]>
Date:   Wed Nov 6 07:38:16 2024 +0100

    REST Server/Client allows configuring the removal of trailing slashs

    Before these changes, the REST server and client extensions were removing the trailing slashes that were set by users in the `@Path` annotations.

    For example, when creating a resource like:

    ```java
    @path("/a/")
    @produces(MediaType.TEXT_PLAIN)
    public class HelloResource {

            @get
            public String echo() {
                // ...
            }
    }
    ```

    The effective path was `/a` instead of `/a/`. Note that it does not matter whether we place the `@Path` annotation at method level because the behaviour will be the same.

    At the client side, when having the following client:

    ```
    @RegisterRestClient(configKey = "test")
    @path("/a/") <1>
    public interface HelloClient {
            @get
            @produces(MediaType.TEXT_PLAIN)
            @path("/b/")  <2>
            String echo();
    }
    ```

    In this case, the trailing slash will be removed from <1> but not from <2>.

    After these changes, we are adding the following properties:
    - `quarkus.rest.removes-trailing-slash`

    To configure the server extension to not remove any trailing slash from the `@Path` annotations.

    - `quarkus.rest-client.removes-trailing-slash`

    To configure the client extension to not remove any traling slash from the `@Path` annotations used at interface level. The annotations set at method level will behave the same.

    Note that this does not introduce any change in behaviour, so everything should keep working as before unless users use the new properties.

commit ae36baf
Author: Jose <[email protected]>
Date:   Wed Nov 6 07:36:36 2024 +0100

    REST Client build time fix for DevServices

commit b0339bd
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Thu Nov 7 22:55:05 2024 +0000

    Bump flyway.version from 10.20.1 to 10.21.0

    Bumps `flyway.version` from 10.20.1 to 10.21.0.

    Updates `org.flywaydb:flyway-core` from 10.20.1 to 10.21.0
    - [Release notes](https://github.com/flyway/flyway/releases)
    - [Commits](flyway/flyway@flyway-10.20.1...flyway-10.21.0)

    Updates `org.flywaydb:flyway-sqlserver` from 10.20.1 to 10.21.0

    Updates `org.flywaydb:flyway-mysql` from 10.20.1 to 10.21.0

    Updates `org.flywaydb:flyway-database-oracle` from 10.20.1 to 10.21.0

    Updates `org.flywaydb:flyway-database-postgresql` from 10.20.1 to 10.21.0

    Updates `org.flywaydb:flyway-database-db2` from 10.20.1 to 10.21.0

    Updates `org.flywaydb:flyway-database-derby` from 10.20.1 to 10.21.0

    Updates `org.flywaydb:flyway-database-mongodb` from 10.20.1 to 10.21.0

    ---
    updated-dependencies:
    - dependency-name: org.flywaydb:flyway-core
      dependency-type: direct:production
      update-type: version-update:semver-minor
    - dependency-name: org.flywaydb:flyway-sqlserver
      dependency-type: direct:production
      update-type: version-update:semver-minor
    - dependency-name: org.flywaydb:flyway-mysql
      dependency-type: direct:production
      update-type: version-update:semver-minor
    - dependency-name: org.flywaydb:flyway-database-oracle
      dependency-type: direct:production
      update-type: version-update:semver-minor
    - dependency-name: org.flywaydb:flyway-database-postgresql
      dependency-type: direct:production
      update-type: version-update:semver-minor
    - dependency-name: org.flywaydb:flyway-database-db2
      dependency-type: direct:production
      update-type: version-update:semver-minor
    - dependency-name: org.flywaydb:flyway-database-derby
      dependency-type: direct:production
      update-type: version-update:semver-minor
    - dependency-name: org.flywaydb:flyway-database-mongodb
      dependency-type: direct:production
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <[email protected]>

commit dd2201e
Author: David M. Lloyd <[email protected]>
Date:   Thu Nov 7 15:32:47 2024 -0600

    Clarify logging rotation docs a little bit

    Fixes quarkusio#44346

commit 2ffe012
Author: Martin Kouba <[email protected]>
Date:   Thu Oct 31 13:56:39 2024 +0100

    Quartz: introduce Nonconcurrent

    - the behavior is identical to a Job class annotated with DisallowConcurrentExecution
    - fixes quarkusio#44048

commit 3d110d1
Author: Antoine de Troostembergh <[email protected]>
Date:   Sun Nov 3 20:54:47 2024 +0100

    add socket log appender and basic ECS json formatting
@cescoffier cescoffier deleted the workshop-structure-adr branch November 14, 2024 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants