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

Improve messages around dependency spec management #17969

Merged
merged 4 commits into from
Jul 3, 2024

Conversation

iliakur
Copy link
Contributor

@iliakur iliakur commented Jul 2, 2024

What does this PR do?

  1. Validation says which commands can fix the failure.
  2. Freeze/sync have docs that make it clear what they do and how they differ.
  3. Freeze says what it's doing to the "static file"

Motivation

I can never remember what the difference between ddev dep freeze and ddev dep sync is. Or which one to use to achieve my goal.

I also find the ddev validate dep error frustrating because it doesn't say how we can fix the failure. Suggesting fixes is something other validations are doing for a while now.

Additional Notes

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Changelog entries must be created for modifications to shipped code
  • Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
  • If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

1. Validation says which commands can fix the failure.
2. Freeze/sync have docs that make it clear what they do and how they differ.
3. Freeze says what it's doing to the "static file"
@iliakur iliakur requested a review from a team as a code owner July 2, 2024 15:43
Copy link

codecov bot commented Jul 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.65%. Comparing base (33f85cc) to head (ce3c3c8).
Report is 2 commits behind head on master.

Additional details and impacted files
Flag Coverage Δ
active_directory 100.00% <ø> (+27.27%) ⬆️
activemq 52.80% <ø> (ø)
activemq_xml 82.31% <ø> (ø)
airflow 92.20% <ø> (?)
amazon_msk 88.91% <ø> (ø)
ambari 85.80% <ø> (ø)
apache 95.08% <ø> (ø)
arangodb 98.23% <ø> (ø)
argo_rollouts 90.00% <ø> (ø)
argo_workflows 87.87% <ø> (ø)
argocd 87.81% <ø> (ø)
aspdotnet 100.00% <ø> (ø)
avi_vantage 91.35% <ø> (ø)
azure_iot_edge 82.08% <ø> (ø)
boundary 100.00% <ø> (ø)
btrfs 82.91% <ø> (ø)
calico 84.61% <ø> (ø)
cassandra 66.66% <ø> (ø)
cassandra_nodetool ?
cert_manager 77.41% <ø> (ø)
cilium 78.20% <ø> (+0.85%) ⬆️
cisco_aci 95.31% <ø> (ø)
citrix_hypervisor 87.50% <ø> (ø)
cloud_foundry_api 96.11% <ø> (ø)
cloudera 99.51% <ø> (ø)
cockroachdb 93.19% <ø> (ø)
confluent_platform ?
consul 91.82% <ø> (ø)
coredns 94.61% <ø> (ø)
couch 94.50% <ø> (+0.23%) ⬆️
couchbase ?
crio 89.79% <ø> (ø)
datadog_checks_base 89.70% <ø> (+0.83%) ⬆️
datadog_checks_dev 77.38% <ø> (+0.07%) ⬆️
datadog_checks_downloader 81.37% <ø> (ø)
datadog_cluster_agent 90.19% <ø> (ø)
dcgm 92.10% <ø> (ø)
ddev 87.93% <100.00%> (ø)
directory 95.68% <ø> (+0.43%) ⬆️
disk 89.34% <ø> (ø)
dns_check 93.33% <ø> (ø)
druid 97.70% <ø> (ø)
ecs_fargate 83.52% <ø> (ø)
eks_fargate 94.05% <ø> (ø)
envoy 92.78% <ø> (-2.12%) ⬇️
esxi 93.05% <ø> (ø)
etcd 95.56% <ø> (ø)
external_dns 89.28% <ø> (ø)
fluentd 84.32% <ø> (ø)
fluxcd 88.31% <ø> (ø)
foundationdb 83.83% <ø> (ø)
gitlab_runner 92.10% <ø> (ø)
go_expvar 92.73% <ø> (ø)
gunicorn 92.83% <ø> (+0.75%) ⬆️
harbor 89.65% <ø> (ø)
hazelcast 92.39% <ø> (ø)
hdfs_datanode 89.74% <ø> (ø)
hdfs_namenode 86.72% <ø> (ø)
hive 51.42% <ø> (ø)
hivemq 61.90% <ø> (ø)
http_check 95.32% <ø> (+2.02%) ⬆️
hudi 73.91% <ø> (?)
ibm_ace 92.25% <ø> (ø)
ibm_db2 86.87% <ø> (ø)
ibm_i 81.91% <ø> (ø)
ibm_mq 91.28% <ø> (ø)
ibm_was ?
ignite 46.66% <ø> (ø)
impala 97.97% <ø> (ø)
istio 78.14% <ø> (+0.51%) ⬆️
jboss_wildfly 47.36% <ø> (ø)
kafka 64.70% <ø> (ø)
kafka_consumer 92.52% <ø> (ø)
karpenter 94.36% <ø> (ø)
kong 87.62% <ø> (ø)
kube_apiserver_metrics 97.74% <ø> (ø)
kube_controller_manager 97.89% <ø> (ø)
kube_dns 95.97% <ø> (ø)
kube_metrics_server 94.87% <ø> (ø)
kube_proxy 96.80% <ø> (ø)
kube_scheduler 97.92% <ø> (ø)
kubelet 91.01% <ø> (ø)
kubernetes_cluster_autoscaler 93.22% <ø> (ø)
kubernetes_state 89.50% <ø> (ø)
kyototycoon 85.96% <ø> (ø)
lighttpd 83.64% <ø> (ø)
linkerd 85.22% <ø> (+1.13%) ⬆️
linux_proc_extras 96.22% <ø> (ø)
mapr 82.42% <ø> (ø)
mapreduce 82.08% <ø> (ø)
marathon 83.12% <ø> (ø)
mcache 93.50% <ø> (ø)
mesos_master 89.81% <ø> (ø)
mesos_slave 93.31% <ø> (ø)
nagios 89.01% <ø> (ø)
network 93.64% <ø> (+1.08%) ⬆️
nfsstat 95.20% <ø> (ø)
nginx 95.07% <ø> (+0.53%) ⬆️
nginx_ingress_controller 98.36% <ø> (ø)
nvidia_triton 88.52% <ø> (ø)
openldap 96.33% <ø> (ø)
openmetrics 98.08% <ø> (ø)
openstack 55.19% <ø> (ø)
openstack_controller 94.44% <ø> (?)
pgbouncer 91.35% <ø> (ø)
php_fpm 90.53% <ø> (+0.82%) ⬆️
postfix 88.10% <ø> (ø)
powerdns_recursor 96.65% <ø> (ø)
presto 59.09% <ø> (ø)
process 85.61% <ø> (ø)
prometheus 94.17% <ø> (ø)
proxysql 98.97% <ø> (ø)
pulsar 100.00% <ø> (ø)
rabbitmq 95.37% <ø> (ø)
ray 96.45% <ø> (ø)
rethinkdb 97.93% <ø> (ø)
riak 99.21% <ø> (ø)
riakcs 87.71% <ø> (ø)
silk 93.82% <ø> (ø)
singlestore 90.81% <ø> (ø)
snowflake 96.27% <ø> (ø)
solr 56.25% <ø> (ø)
spark 93.87% <ø> (ø)
squid 100.00% <ø> (ø)
statsd 87.36% <ø> (ø)
strimzi 89.78% <ø> (ø)
supervisord 89.78% <ø> (ø)
system_core 92.66% <ø> (ø)
system_swap 98.30% <ø> (ø)
tcp_check 90.39% <ø> (ø)
teamcity 88.57% <ø> (+3.17%) ⬆️
tekton 82.30% <ø> (ø)
teleport 99.61% <ø> (ø)
temporal 100.00% <ø> (ø)
teradata 94.05% <ø> (ø)
tls 92.02% <ø> (+0.86%) ⬆️
tokumx 57.52% <ø> (ø)
torchserve 97.32% <ø> (ø)
traefik_mesh 76.75% <ø> (ø)
traffic_server 96.13% <ø> (ø)
twemproxy 79.56% <ø> (ø)
twistlock 80.47% <ø> (ø)
varnish 84.39% <ø> (+0.26%) ⬆️
vllm 93.10% <ø> (ø)
weaviate 76.27% <ø> (ø)
win32_event_log 82.67% <ø> (+1.11%) ⬆️
wmi_check 97.50% <ø> (ø)
yarn 89.52% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@iliakur iliakur merged commit 3b646f7 into master Jul 3, 2024
378 of 382 checks passed
@iliakur iliakur deleted the ik/better-error-messages branch July 3, 2024 09:10
github-actions bot pushed a commit that referenced this pull request Jul 3, 2024
* Improve messages around dependency spec management

1. Validation says which commands can fix the failure.
2. Freeze/sync have docs that make it clear what they do and how they differ.
3. Freeze says what it's doing to the "static file"

* add changelog

* adjust test 3b646f7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants