Create the structure to handle ADRs #16996
Conversation
cescoffier
commented
May 5, 2021
cescoffier
commented
- Create the structure as discussed on https://groups.google.com/d/msgid/quarkus-dev/CB395F5B-5A01-464C-8008-A0E8E7E247E6%40redhat.com?utm_medium=email&utm_source=footer
- Update the template to MADR
|
I was wondering if it should be in a specific repo? Frankly the GH search engine is a massive pain and I'm afraid it will be hard to find a decision in the middle of the rest. |
|
If these files are supposed to be here, better fix the CI to not run the full build too |
|
I'm not against moving them to another repo. However, it would mean that only some people aware of such a repo will follow the PR and evolution. About the search engine, the file type may help, but I agree, not the best search engine. |
|
This workflow status is outdated as a new workflow run has been triggered. Failing Jobs - Building a18aba5
Full information is available in the Build summary check run. Test Failures⚙️ JVM Tests - JDK 11 #📦 extensions/smallrye-reactive-messaging-amqp/deployment✖ ⚙️ JVM Tests - JDK 15 #📦 integration-tests/artemis-core✖ 📦 integration-tests/artemis-jms✖ 📦 integration-tests/bootstrap-config/application✖ 📦 integration-tests/cache✖ 📦 integration-tests/consul-config✖ 📦 integration-tests/container-image/quarkus-standard-way✖ 📦 integration-tests/devmode✖ 📦 integration-tests/elytron-security-jdbc✖ 📦 integration-tests/elytron-security-ldap✖ 📦 integration-tests/google-cloud-functions-http✖ 📦 integration-tests/grpc-health✖ ✖ 📦 integration-tests/grpc-interceptors✖ 📦 integration-tests/grpc-mutual-auth✖ 📦 integration-tests/grpc-plain-text-gzip✖ 📦 integration-tests/grpc-plain-text-mutiny✖ 📦 integration-tests/grpc-proto-v2✖ 📦 integration-tests/grpc-streaming✖ 📦 integration-tests/grpc-tls✖ 📦 integration-tests/injectmock✖ 📦 integration-tests/jackson✖ 📦 integration-tests/jaxp✖ 📦 integration-tests/jgit✖ 📦 integration-tests/jpa-without-entity✖ 📦 integration-tests/jsch✖ 📦 integration-tests/jsonb✖ 📦 integration-tests/kubernetes-client✖ ✖ ✖ ✖ ✖ ✖ ✖ 📦 integration-tests/kubernetes-service-binding-jdbc✖ 📦 integration-tests/logging-gelf✖ 📦 integration-tests/logging-json✖ 📦 integration-tests/logging-min-level-set✖ 📦 integration-tests/logging-min-level-unset✖ 📦 integration-tests/mailer✖ 📦 integration-tests/micrometer-mp-metrics✖ 📦 integration-tests/micrometer-prometheus✖ 📦 integration-tests/mongodb-client✖ ✖ 📦 integration-tests/mongodb-panache-kotlin✖ 📦 integration-tests/mongodb-panache✖ 📦 integration-tests/mongodb-rest-data-panache✖ 📦 integration-tests/narayana-jta✖ 📦 integration-tests/narayana-stm✖ 📦 integration-tests/neo4j✖ 📦 integration-tests/openshift-client✖ 📦 integration-tests/opentelemetry✖ 📦 integration-tests/picocli-native✖ 📦 integration-tests/quartz✖ 📦 integration-tests/qute✖ 📦 integration-tests/reactive-messaging-amqp✖ 📦 integration-tests/reactive-messaging-http✖ 📦 integration-tests/reactive-messaging-kafka✖ 📦 integration-tests/redis-client✖ 📦 integration-tests/rest-client✖ 📦 integration-tests/resteasy-mutiny✖ 📦 integration-tests/resteasy-reactive-kotlin✖ 📦 integration-tests/resteasy-reactive-rest-client-standalone✖ 📦 integration-tests/resteasy-reactive-rest-client✖ 📦 integration-tests/simple with space✖ 📦 integration-tests/smallrye-config✖ ✖ ✖ 📦 integration-tests/smallrye-context-propagation✖ ✖ ✖ ✖ 📦 integration-tests/smallrye-graphql✖ 📦 integration-tests/smallrye-metrics✖ 📦 integration-tests/tika✖ 📦 integration-tests/vertx-graphql✖ 📦 integration-tests/virtual-http-resteasy✖ 📦 integration-tests/virtual-http✖ 📦 integration-tests/webjars-locator✖ |
cescoffier
force-pushed
the
adr-structure
branch
2 times, most recently
from
1216e70
to
429e151
Compare
quarkus-bot
bot
added
the
area/infra-automation
|
This workflow status is outdated as a new workflow run has been triggered. 🚫 This workflow run has been cancelled. Failing Jobs - Building 1216e70
|
|
I've excluded the ADR directory from the build. |
|
To me they belong in this repo, and can be found by checking it out and using an IDE or file exporer, or by using the explorer view of github and Ctrl-F, no need to use the search box. Or are we expecting hundreds of such ADRs? |
There was a problem hiding this comment.
This mostly looks good, and I'm in favour of ADRs.
But I see no explanation as to what the process is that leads from proposed to either accepted or rejected.
Is it a vote? What sort? By whom? Time-boxed?
Same for deprecated: what's the process to deprecate an ADR? A PR changing its status? Where do we document why it was deprecated and what to use/do instead?
For superceded, I guess the process is that there's a new ADR in the same PR that supercedes the other, right? In the case of RFCs it helps tremendously if the new ADR links to the deprecated ones. We'll probably also have to document why it became superceded (in the old or new ADR?)
|
This workflow status is outdated as a new workflow run has been triggered. Failing Jobs - Building 429e151
Full information is available in the Build summary check run. Test Failures⚙️ JVM Tests - JDK 15 #📦 integration-tests/artemis-core✖ 📦 integration-tests/artemis-jms✖ 📦 integration-tests/bootstrap-config/application✖ 📦 integration-tests/cache✖ 📦 integration-tests/consul-config✖ 📦 integration-tests/container-image/quarkus-standard-way✖ 📦 integration-tests/devmode✖ 📦 integration-tests/elytron-security-jdbc✖ 📦 integration-tests/elytron-security-ldap✖ 📦 integration-tests/google-cloud-functions-http✖ 📦 integration-tests/grpc-health✖ ✖ 📦 integration-tests/grpc-interceptors✖ 📦 integration-tests/grpc-mutual-auth✖ 📦 integration-tests/grpc-plain-text-gzip✖ 📦 integration-tests/grpc-plain-text-mutiny✖ 📦 integration-tests/grpc-proto-v2✖ 📦 integration-tests/grpc-streaming✖ 📦 integration-tests/grpc-tls✖ 📦 integration-tests/injectmock✖ 📦 integration-tests/jackson✖ 📦 integration-tests/jaxp✖ 📦 integration-tests/jgit✖ 📦 integration-tests/jpa-without-entity✖ 📦 integration-tests/jsch✖ 📦 integration-tests/jsonb✖ 📦 integration-tests/kubernetes-client✖ ✖ ✖ ✖ ✖ ✖ ✖ 📦 integration-tests/kubernetes-service-binding-jdbc✖ 📦 integration-tests/logging-gelf✖ 📦 integration-tests/logging-json✖ 📦 integration-tests/logging-min-level-set✖ 📦 integration-tests/logging-min-level-unset✖ 📦 integration-tests/mailer✖ 📦 integration-tests/micrometer-mp-metrics✖ 📦 integration-tests/micrometer-prometheus✖ 📦 integration-tests/mongodb-client✖ ✖ 📦 integration-tests/mongodb-panache-kotlin✖ 📦 integration-tests/mongodb-panache✖ 📦 integration-tests/mongodb-rest-data-panache✖ 📦 integration-tests/narayana-jta✖ 📦 integration-tests/narayana-stm✖ 📦 integration-tests/neo4j✖ 📦 integration-tests/openshift-client✖ 📦 integration-tests/opentelemetry✖ 📦 integration-tests/picocli-native✖ 📦 integration-tests/quartz✖ 📦 integration-tests/qute✖ 📦 integration-tests/reactive-messaging-amqp✖ 📦 integration-tests/reactive-messaging-http✖ 📦 integration-tests/reactive-messaging-kafka✖ 📦 integration-tests/redis-client✖ 📦 integration-tests/rest-client✖ 📦 integration-tests/resteasy-mutiny✖ 📦 integration-tests/resteasy-reactive-kotlin✖ 📦 integration-tests/resteasy-reactive-rest-client-standalone✖ 📦 integration-tests/resteasy-reactive-rest-client✖ 📦 integration-tests/simple with space✖ 📦 integration-tests/smallrye-config✖ ✖ ✖ 📦 integration-tests/smallrye-context-propagation✖ ✖ ✖ ✖ 📦 integration-tests/smallrye-graphql✖ 📦 integration-tests/smallrye-metrics✖ 📦 integration-tests/tika✖ 📦 integration-tests/vertx-graphql✖ 📦 integration-tests/virtual-http-resteasy✖ 📦 integration-tests/virtual-http✖ 📦 integration-tests/webjars-locator✖ |
I agree we need some kind of process, but not a heavy one, that would kill everything.
That's a good question. It's actually interesting as no other ADR describe this process. The status is changed, but no reason given. We should include a reason.
Yes, that should be the same PR, and the status links to the new document. I will update the PR with these changes. |
|
@FroMage PR udpated. I've added more details about the process. |
|
I'm more talking about having pull requests lost in the middle of the rest. Not about being able to search files in a specific directory. Please at least add a triage rule to attach a label to the PRs. |
|
+1 for the label. I already created an area/adr label, so I just need to update the bot rules, right? |
|
(BTW, I don't expect hundreds of ADR PRs, at least that's my hope) |
|
+1 on this. just one suggestion: I love adoc but may I suggest we use markdown for the .adrs as then we can use hackmd.io for collaborative editing (think google doc editing but without the google doc part) on these ? btw. what is MADR? |
|
@maxandersen I'm not against markdown, but the lack of admonition and xref is a bit annoying. But I don't have a strong opinion (Except that I need to check the link syntax every single time). MADR is the name of the structure I used as base: https://github.com/adr/madr |
|
LGTM, but I think more than just us four should vote on this. |
There was a problem hiding this comment.
Missing the auto label rules as @gsmet suggested.
With respect to .md we can just try hackmd on some as experiment and see if great or not worth jt. Let's not hold back this pr because of that.
|
This workflow status is outdated as a new workflow run has been triggered. Failing Jobs - Building a802643
Full information is available in the Build summary check run. Test Failures⚙️ JVM Tests - JDK 11 Windows #📦 extensions/vertx-http/deployment✖ |
|
I added the auto-label rule. Update: Dead by Yaml.... |
|
This workflow status is outdated as a new workflow run has been triggered. 🚫 This workflow run has been cancelled. Failing Jobs - Building 58f413f
Full information is available in the Build summary check run. Test Failures⚙️ Gradle Tests - JDK 11 Linux #📦 integration-tests/gradle✖ ✖ ✖ ✖ ✖ |
|
This workflow status is outdated as a new workflow run has been triggered. 🚫 This workflow run has been cancelled. Failing Jobs - Building 1f8cbe4
Full information is available in the Build summary check run. Test Failures⚙️ Gradle Tests - JDK 11 Linux #📦 integration-tests/gradle✖ ✖ ✖ ✖ ✖ ⚙️ Gradle Tests - JDK 11 Windows #📦 integration-tests/gradle✖ ✖ ✖ ✖ ✖ |
- Create the structure as discussed on https://groups.google.com/d/msgid/quarkus-dev/CB395F5B-5A01-464C-8008-A0E8E7E247E6%40redhat.com?utm_medium=email&utm_source=footer - Update the template to MADR - Disable CI on adr update - Configure the bot to auto-label and notify on new ADR
|
This workflow status is outdated as a new workflow run has been triggered. 🚫 This workflow run has been cancelled. Failing Jobs - Building 35ea0a2
|
Failing Jobs - Building a655126
Full information is available in the Build summary check run. Test Failures⚙️ Gradle Tests - JDK 11 Linux #📦 integration-tests/gradle✖ ✖ ✖ ✖ ✖ ⚙️ Gradle Tests - JDK 11 Windows #📦 integration-tests/gradle✖ ✖ ✖ ✖ ✖ |
|
Moving forward, structure and process will be revisited if needed. |
