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

Add ci_bundle_pr_artifacts() #139

Merged
merged 16 commits into from
Aug 11, 2021
Merged

Add ci_bundle_pr_artifacts() #139

merged 16 commits into from
Aug 11, 2021

Conversation

zkamvar
Copy link
Contributor

@zkamvar zkamvar commented Aug 10, 2021

there are two things that happened in this PR:

  1. ci_bundle_pr_artifacts() has been added and tested with a snapshot of the example output
  2. git_worktree_setup() has been documented with examples
  3. the issue with the disappearing remote found in Add tests for git functions #137 has been fixed in fb9966b
  4. testing of ci_deploy() has been updated to be not so timestamp dependent

Here's an example of the new PR message:

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/[user]/lesson/compare/landpaper-socal...landpaper-socal-PR-42

The following changes were observed in the rendered markdown documents:

 deleteme       | 1 +
 emeteled (new) | 1 +
 2 files changed, 2 insertions(+)
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 2021-08-11 20:44:26 +0000

Surprise surprise: it turns out the stackoverflow solution worked for
what I needed at the time, but was certainly not a general solution.
Here, I'm spelling out the explicit refspec string so that git will know
which branch I'm fetching and _hopefully_ it will be more clear for
future folk.
GHA will complain if the git user and email is not set... for good
reason!
Working on other people's computers is hard, y'all
The CI deploy tests were giving strange results on different systems, so
it was better to test the _concept_ of a branch _existing_ rather than
the number of commits that were recorded. I believe the issue with the
differing number of commits on the SITE branch is due to time splitting
between minutes across tests (e.g. if the first deploy test happens in
the same minute as the second deploy test, then there would be no
change, but if it happened across times, then there would be three
commits).
 - Move PR message out of code and into template
 - expand on the prose in the PR message to be compliant with heading
   rules (don't start with level 3)
 - add clear description and link for people to report any issues
 - use triple-dot notation for linking to diffs so that people do not
   become discouraged from changes that happened upstream.
 - add timestamp to the file
 - update snapshot to compare the file without the timestamp
@zkamvar zkamvar changed the title Add bundle_pr_artifacts() Add ci_bundle_pr_artifacts() Aug 11, 2021
@zkamvar zkamvar marked this pull request as ready for review August 11, 2021 20:48
@zkamvar zkamvar merged commit 6dfb668 into main Aug 11, 2021
@zkamvar zkamvar deleted the update-deployments branch August 11, 2021 20:59
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.

None yet

1 participant