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

No score in e-mail for PEGS #40

Merged
merged 2 commits into from
Jul 31, 2024
Merged

No score in e-mail for PEGS #40

merged 2 commits into from
Jul 31, 2024

Conversation

jaymedina
Copy link

@jaymedina jaymedina commented Jul 30, 2024

problem

We want e-mails sent out to participants, just not with a score value.

solution

Set email_with_score to "no"

testing

Workflow run for INVALID submission
Workflow run for VALID submission

@jaymedina jaymedina requested a review from vpchung July 30, 2024 18:01
@jaymedina jaymedina requested a review from a team as a code owner July 30, 2024 18:01
@@ -46,7 +46,7 @@ profiles {
params.goldstandard_id = "syn58888786"
params.private_folders = "predictions"
params.challenge_container = "ghcr.io/sage-bionetworks-challenges/pegs-evaluation:latest"
params.send_email = false

Choose a reason for hiding this comment

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

These are a confusing set of parameters - Do we have any control to update this?

I would assume that we would be setting:
send_email = true

at a base level that determines Yes/No we are sending at an email at all. Then come the flags to modify the content that would be included in the email such as:

include_score_in_email True/False

Copy link

@BryanFauble BryanFauble Jul 30, 2024

Choose a reason for hiding this comment

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

I see from the docs that send_email defaults to true. Since we are modifying the flags around it I would keep send_email = true in this config so it isn't misinterpreted that email_with_score is controlling it:

send_email (optional): If true, sends an e-mail to the submitter on the status of their submission. Default is true.

Either way I understand now how this is set up.

Copy link
Author

Choose a reason for hiding this comment

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

I think this is a good point- There's a little bit of cleanup I can do with the way e-mail templates are chosen (with/without score). One of them being the wording and the other being why one is handled with a boolean and the other with a string. I'll make a quick tech debt ticket for this.

Copy link

@BryanFauble BryanFauble left a comment

Choose a reason for hiding this comment

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

Going to approve as the changes work, although the flags are slightly confusing when looking at them in a vacuum.

Copy link

sonarcloud bot commented Jul 30, 2024

@jaymedina jaymedina merged commit bd3890c into main Jul 31, 2024
2 checks passed
@jaymedina jaymedina deleted the pegs-no-score-email branch July 31, 2024 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants