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

Fix #8406 - Fix the failing 'documentation' github actions workflow #8407

Merged
merged 1 commit into from
Dec 2, 2020

Conversation

jmarrec
Copy link
Contributor

@jmarrec jmarrec commented Dec 2, 2020

Pull request overview

Fix #8406 - Fix the failing 'documentation' github actions workflow

Documentation build worked as expected with the PR: https://github.com/NREL/EnergyPlus/pull/8407/checks?check_run_id=1486710834

It took 58 s for the Setup Latex step with the apt update

Without it, I see the last non failed run taking 1m8s, so the apt update appears to be very fast. (https://github.com/NREL/EnergyPlus/runs/1461185282?check_suite_focus=true)

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@jmarrec jmarrec added Defect Includes code to repair a defect in EnergyPlus DoNotPublish Includes changes that shouldn't be reported in the changelog NotIDDChange Code does not impact IDD (can be merged after IO freeze) labels Dec 2, 2020
@jmarrec jmarrec requested a review from Myoldmopar December 2, 2020 14:12
@jmarrec jmarrec self-assigned this Dec 2, 2020
@@ -16,7 +16,7 @@ jobs:
python-version: 3.7

- name: Set up LaTeX
run: sudo apt-get install texlive texlive-xetex texlive-science
run: sudo apt update && sudo apt install -y texlive texlive-xetex texlive-science
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Simple: the docker has outdated apt list, so need to update it first.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm also throwing a -y flag to the apt install for good form.

@Myoldmopar
Copy link
Member

Works for me! Thanks for fixing this @jmarrec, I'm not going to wait on all the other actions to report back for this one.

@Myoldmopar Myoldmopar merged commit 2ebb7d5 into develop Dec 2, 2020
@Myoldmopar Myoldmopar deleted the fix_documentation_gh-actions branch December 2, 2020 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Defect Includes code to repair a defect in EnergyPlus DoNotPublish Includes changes that shouldn't be reported in the changelog NotIDDChange Code does not impact IDD (can be merged after IO freeze)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix 'documentation' github actions
6 participants