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

delete instructor handouts #469

Merged
merged 1 commit into from
Jul 25, 2023

Conversation

zkamvar
Copy link
Contributor

@zkamvar zkamvar commented Jul 11, 2023

This is a followup to #466 in relation to #464 because the lesson build is currently failing with this error during the HTML build phase:

  Error in normalizePath(path, winslash = "/", mustWork = TRUE) : 
    path[1]="/home/runner/work/r-socialsci/r-socialsci/site/built/data-visualisation-handout.md": No such file or directory
  Calls: <Anonymous> ... root_path -> <Anonymous> -> get_start_path -> normalizePath
Details of error

In the workbench transition (see #411 (comment)) for this lesson, the default spot for any of the materials in the _extras/ folder was instructors/ and I had accidentally copied the files to the learners/ folder instead of moving them from the instructors/ folder.

When building the lesson site, {sandpaper} flattens the folder structure, which unfortunately means that files with identical names are overwritten according to the build order alphabetically by folder ([root], episodes, instructors, learners). It never showed up here because the instructor handouts were identical to the learner handouts at the beginning and then subsequently diverged. No one noticed because the learner handouts always overwrote the instructor handouts.

The mechanism for failure here is that the md5sum table used for cache invalidation of built markdown files had a record of the markdown files for both learners and instructors, but because the learner handout removal clobbered the instructor handouts at the end of the build phase, {sandpaper} was unable to find those files afterwards.

I am sorry about the mixup and will address this in {sandpaper} soon.

Note: the other solution to this is to re-run the lesson build and reset the cached markdown files, but this PR is much preferred.

@github-actions
Copy link

github-actions bot commented Jul 11, 2023

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/datacarpentry/r-socialsci/compare/md-outputs..md-outputs-PR-469

The following changes were observed in the rendered markdown documents:

 md5sum.txt | 4 ----
 1 file changed, 4 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2023-07-11 14:17:17 +0000

github-actions bot pushed a commit that referenced this pull request Jul 11, 2023
@zkamvar
Copy link
Contributor Author

zkamvar commented Jul 20, 2023

Another ping on this

@zkamvar
Copy link
Contributor Author

zkamvar commented Jul 25, 2023

Another reminder for this. The scheduled builds will continue to fail until this is merged: https://github.com/datacarpentry/r-socialsci/actions/runs/5651197828

@juanfung
Copy link
Contributor

@zkamvar sorry for the delay and thank you!

@juanfung juanfung merged commit 621ea29 into datacarpentry:main Jul 25, 2023
github-actions bot pushed a commit that referenced this pull request Jul 25, 2023
Auto-generated via {sandpaper}
Source  : 621ea29
Branch  : main
Author  : Juan Fung <[email protected]>
Time    : 2023-07-25 17:57:09 +0000
Message : Merge pull request #469 from zkamvar/del-instructor-handouts

delete instructor handouts
github-actions bot pushed a commit that referenced this pull request Jul 25, 2023
Auto-generated via {sandpaper}
Source  : 40600b8
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-07-25 17:59:01 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 621ea29
Branch  : main
Author  : Juan Fung <[email protected]>
Time    : 2023-07-25 17:57:09 +0000
Message : Merge pull request #469 from zkamvar/del-instructor-handouts

delete instructor handouts
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.

2 participants