Add documentation for LFS caching, The Bridge and Save Atomic Files Workflow #2288

atharva-2001 · 2023-05-04T12:14:00Z

📝 Description

🚦 testing | 📝 documentation | 🎢 infrastructure

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

Testing pipeline
Other method (describe)
My changes can't be tested (explain why)

☑️ Checklist

I requested two reviewers for this pull request
I updated the documentation according to my changes
I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

codecov · 2023-05-04T12:27:34Z

Codecov Report

Merging #2288 (43befcd) into master (b8f0af5) will not change coverage.
The diff coverage is n/a.

❗ Current head 43befcd differs from pull request most recent head 26797d7. Consider uploading reports for the commit 26797d7 to get more accurate results

@@           Coverage Diff           @@
##           master    #2288   +/-   ##
=======================================
  Coverage   68.49%   68.49%           
=======================================
  Files         145      145           
  Lines       13245    13245           
=======================================
  Hits         9072     9072           
  Misses       4173     4173

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

tardis-bot · 2023-05-04T12:31:10Z

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

andrewfullard · 2023-06-01T13:10:55Z

docs/contributing/development/continuous_integration.rst

+`this notebook <https://github.com/tardis-sn/tardis-refdata/blob/master/notebooks/ref_data_compare_from_paths.ipynb>`_.
+The workflow has a ``workflow_dispatch`` event so that it can be triggered manually, but is also 
+triggered every week due to the "save-atomic-files" workflow. 
+The bridge fails currently there is a discrepancy between 


I don't think it's worth including this information since it requires us to keep it up to date.

Should we then have a general statement about the purpose of the workflow? Or should I remove the entire added documentation for the bridge and the save-atomic-files workflow?

No, the part you should remove is that "the bridge fails currently..." the documentation should just include the intended behaviour. Issues should list problems with that intended behaviour.

andrewfullard

Please remove the bit about the failing bridge

sonachitchyan

Why does the benchmark workflow fail here?

atharva-2001 · 2023-07-10T08:21:51Z

Why does the benchmark workflow fail here?

@sonachitchyan It's just to see how the workflow runs. The benchmarks workflow has nothing to do with this pull request. I just wanted to try the workflow somewhere so I ran it here.
As to why it fails- the comment isn't made because the workflow is a pull_request event. I would open a PR to fix it in sometime.

andrewfullard · 2023-08-18T13:54:21Z

Rebase and we can just merge this.

tardis-bot · 2023-08-23T14:49:38Z

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing master (b8f0af5) and the latest commit (26797d7).
Here are the logs produced by ASV.
Results can also be downloaded as artifacts here.
Significantly changed benchmarks:

All benchmarks:

All benchmarks:

     before           after         ratio
   [b8f0af59]       [26797d77]
        731±4ms        715±0.2ms     0.98  benchmark_run_tardis.Benchmarkruntardis.time_run_tardis

atharva-2001 added documentation build-docs labels May 4, 2023

atharva-2001 requested review from epassaro and sonachitchyan May 22, 2023 12:31

atharva-2001 marked this pull request as ready for review May 24, 2023 13:31

atharva-2001 changed the title ~~Add documentation for LFS caching~~ Add documentation for LFS caching, The Bridge and Save Atomic Files Workflow May 24, 2023

atharva-2001 requested a review from andrewfullard June 1, 2023 13:07

andrewfullard reviewed Jun 1, 2023

View reviewed changes

andrewfullard enabled auto-merge (squash) June 1, 2023 13:11

atharva-2001 requested a review from andrewfullard June 11, 2023 04:29

atharva-2001 added the benchmarks label Jun 16, 2023

andrewfullard requested changes Jun 16, 2023

View reviewed changes

atharva-2001 requested a review from andrewfullard June 19, 2023 09:54

atharva-2001 removed the benchmarks label Jun 19, 2023

andrewfullard previously approved these changes Jun 19, 2023

View reviewed changes

sonachitchyan reviewed Jun 28, 2023

View reviewed changes

atharva-2001 force-pushed the tests_bridge_docs branch from d1506fd to 72dc3f7 Compare June 30, 2023 12:59

atharva-2001 added the benchmarks label Jun 30, 2023

andrewfullard requested a review from sonachitchyan June 30, 2023 13:07

atharva-2001 added 5 commits August 23, 2023 20:06

Cache LFS docs [build docs]

814d8bb

Remove brackets

7ee99dc

Documentation for bridge and save-atomic-files workflows

670fb13

rerun workflow

3deaefe

Remove failing bridge

f49107c

atharva-2001 dismissed andrewfullard’s stale review via f49107c August 23, 2023 14:37

atharva-2001 force-pushed the tests_bridge_docs branch from 72dc3f7 to f49107c Compare August 23, 2023 14:37

andrewfullard self-requested a review August 23, 2023 14:42

andrewfullard previously approved these changes Aug 23, 2023

View reviewed changes

Fix syntax

26797d7

atharva-2001 dismissed andrewfullard’s stale review via 26797d7 August 24, 2023 09:07

atharva-2001 requested a review from andrewfullard August 24, 2023 09:07

andrewfullard approved these changes Aug 24, 2023

View reviewed changes

sonachitchyan approved these changes Sep 8, 2023

View reviewed changes

andrewfullard merged commit dffac0a into tardis-sn:master Sep 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for LFS caching, The Bridge and Save Atomic Files Workflow #2288

Add documentation for LFS caching, The Bridge and Save Atomic Files Workflow #2288

atharva-2001 commented May 4, 2023

codecov bot commented May 4, 2023 •

edited

Loading

tardis-bot commented May 4, 2023 •

edited

Loading

andrewfullard Jun 1, 2023

atharva-2001 Jun 5, 2023 •

edited

Loading

andrewfullard Jun 12, 2023

atharva-2001 Jun 19, 2023

andrewfullard left a comment

sonachitchyan left a comment

atharva-2001 commented Jul 10, 2023 •

edited

Loading

andrewfullard commented Aug 18, 2023

tardis-bot commented Aug 23, 2023 •

edited

Loading

Add documentation for LFS caching, The Bridge and Save Atomic Files Workflow #2288

Add documentation for LFS caching, The Bridge and Save Atomic Files Workflow #2288

Conversation

atharva-2001 commented May 4, 2023

📝 Description

📌 Resources

🚦 Testing

☑️ Checklist

codecov bot commented May 4, 2023 • edited Loading

Codecov Report

tardis-bot commented May 4, 2023 • edited Loading

andrewfullard Jun 1, 2023

Choose a reason for hiding this comment

atharva-2001 Jun 5, 2023 • edited Loading

Choose a reason for hiding this comment

andrewfullard Jun 12, 2023

Choose a reason for hiding this comment

atharva-2001 Jun 19, 2023

Choose a reason for hiding this comment

andrewfullard left a comment

Choose a reason for hiding this comment

sonachitchyan left a comment

Choose a reason for hiding this comment

atharva-2001 commented Jul 10, 2023 • edited Loading

andrewfullard commented Aug 18, 2023

tardis-bot commented Aug 23, 2023 • edited Loading

codecov bot commented May 4, 2023 •

edited

Loading

tardis-bot commented May 4, 2023 •

edited

Loading

atharva-2001 Jun 5, 2023 •

edited

Loading

atharva-2001 commented Jul 10, 2023 •

edited

Loading

tardis-bot commented Aug 23, 2023 •

edited

Loading