Skip to content

Static HTML diffs#246

Draft
Yannicked wants to merge 15 commits into
iterorganization:developfrom
Yannicked:feature/html-diff
Draft

Static HTML diffs#246
Yannicked wants to merge 15 commits into
iterorganization:developfrom
Yannicked:feature/html-diff

Conversation

@Yannicked

@Yannicked Yannicked commented May 18, 2026

Copy link
Copy Markdown
Contributor

Generates HTML diffs for every created PR.

Example: https://scdimasdictionnarysa.z6.web.core.windows.net/


📚 Documentation preview 📚: https://imas-data-dictionary--246.org.readthedocs.build/en/246/

@Yannicked
Yannicked force-pushed the feature/html-diff branch 2 times, most recently from 093a709 to 94f4f10 Compare May 18, 2026 12:46
@Yannicked
Yannicked force-pushed the feature/html-diff branch from 94f4f10 to ca30867 Compare May 18, 2026 12:48
@github-actions

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown

@maarten-ic maarten-ic left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

A couple of comments, let me know if you want to discuss them

Comment thread .github/workflows/pr_diff_comment_on_pr.yml Outdated
Comment thread .github/workflows/pr_diff_comment_on_pr.yml Outdated
Comment thread .github/workflows/pr_diff_comment_on_pr.yml
Comment on lines +119 to +125
if (regex.test(body)) {
body = body.replace(regex, contentBlock);
console.log("Existing XML Diff block found and updated.");
} else {
body = body ? `${body}\n\n${contentBlock}` : contentBlock;
console.log("XML Diff block added to the end of the PR description.");
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Could we get race conditions with the workflow from ReadTheDocs?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've added a 10 second waiting function to wait for the read the docs workflow to complete. Let me know what you think

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Hmm, looks a bit complicated... Could we integrate this link with the workflow for RTD instead?

Comment thread scripts/diff_template.html.jinja
@github-actions

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

As just discussed in the DD progress meeting, ITER'd like to keep this one around for a bit longer.
Could you un-remove it please?

--content-type "text/html" \
--auth-mode key
- name: Check and wait for readthedocs (Max 10s)
id: check-workflows

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why the extra indentation here? Shouldn't these lines line-up under name ?

Suggested change
id: check-workflows
id: check-workflows

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants