Skip to content

Conversation

@H0R5E
Copy link
Contributor

@H0R5E H0R5E commented May 6, 2022

This PR updates the CI workflows in 4 ways:

  • Firstly, the docs CI workflow is split into two independent jobs which allows the commit author to see any new issues they may be adding to the docs while not preventing the docs from being published:
    • The first job (test) checks the current branch build and any warnings will trigger a failure.
    • The second job (build) builds and deploys the production docs, allowing any warnings to pass.
  • Secondly, color has been enabled for the sphinx output logging to help with identifying issues.
  • Thirdly, previous runs on the same branch are now cancelled if not complete when a new commit is added. This will help use the available runners more efficiently. I recommend we port this change to WEC-Sim_Applications as well. I've excluded the unit-tests on pushes (still working for PRs) to the master and dev branches from this, as we'll always want them to finish testing if we are using a coverage service like codecov, in the future.
  • Finally, now that MATLAB R2022a is the latest version, I've explicitly added R2021b to the versions tested in the unit tests, which was the previous latest.

I also fixed the issue with the docs added in #847.

H0R5E added 6 commits May 6, 2022 17:21
This PR splits the docs CI workflow into two independent jobs. The
first "test" job checks the current branch with any warnings
triggering a failure. The second jobs builds and deploys the
production docs, allowing any warnings to pass. This allows the
commit author to see any new issues they may be adding to the docs
while not stopping the docs being published.
@H0R5E H0R5E changed the title Split docs CI into test and build jobs CI: Split docs jobs | Add color to docs logs | Cancel runs on new push May 6, 2022
@H0R5E H0R5E marked this pull request as ready for review May 6, 2022 16:56
@kmruehl kmruehl added the Tests/CI related WEC-Sim tests or Continuous Integration label May 12, 2022
H0R5E added 2 commits May 12, 2022 16:20
This is to ensure all commits on the master and dev branches are
tested, which will be important if we are going to measure
coverage using an external service like codecov.
@H0R5E H0R5E changed the title CI: Split docs jobs | Add color to docs logs | Cancel runs on new push CI: Split docs jobs | Add color to docs logs | Cancel runs on new push | Add 2021b to MATLAB versions May 12, 2022
@kmruehl kmruehl self-requested a review May 18, 2022 14:42
@kmruehl kmruehl added the Documentation related to docs label May 18, 2022
@akeeste akeeste self-requested a review June 29, 2022 15:14
@kmruehl
Copy link
Collaborator

kmruehl commented Jun 29, 2022

Thanks @H0R5E, merging now

@kmruehl kmruehl merged commit 09b2b49 into WEC-Sim:master Jun 29, 2022
@akeeste akeeste mentioned this pull request Jun 29, 2022
akeeste added a commit that referenced this pull request Jul 1, 2022
* Update README.md

adding dev and master build status to README

* adding v5.0 release notes

* Fix typo in docs. (#898)

* Update documentation tutorials to fix OSWEC inertia (#894)

* Update tutorials to fix OSWEC inertia

* Update terminology.rst

* Update tutorials.rst

changed OSWEC Iyy and added note

Co-authored-by: Kelley Ruehl <kmruehl@sandia.gov>

* CI: Split docs jobs | Add color to docs logs | Cancel runs on new push | Add 2021b to MATLAB versions (#862)

* Split docs CI into test and build jobs

This PR splits the docs CI workflow into two independent jobs. The
first "test" job checks the current branch with any warnings
triggering a failure. The second jobs builds and deploys the
production docs, allowing any warnings to pass. This allows the
commit author to see any new issues they may be adding to the docs
while not stopping the docs being published.

* Try to get color output in log

* Remove redundant steps for branch test

* Fix duplicate targets using anonymous references

* Cancel previous runs if new commits are made

* Fix spelling mistake to test concurrency

* Limit concurrency to pull requests for the unit tests

This is to ensure all commits on the master and dev branches are
tested, which will be important if we are going to measure
coverage using an external service like codecov.

* Fix another spelling mistake

* Add R2021b to explicit MATLAB versions tested

* resolve code struc table bug

* [Bug fix] Mac path fixes and make outputDir public (#874)

* Moved simulationClass.outputDir to public.

* Replaced paths with fullfile paths in CompareBEMIO.m. The paths didd not work on Mac due to file separator.

* Update line 38 in reaadAQWA.m so it works on a Mac.

* change filesep in BEMIO examples, update readAQWA fileparts

* Update stopWecSim.m

Replaced hardcoded 'output' string with simu.outputDir.

* Removed clc and close all from initializeWecSim.

It should be up to the user to clear the command windows and close the figures.

Co-authored-by: Lermart96 <anders.brandt@oceanharvesting.com>
Co-authored-by: akeeste <akeeste@sandia.gov>

* resolving doc language bug

* wecSimPCT Fix (Master) (#870)

* Update stopWecSim.m

* Update initializeWecSim.m

* Update wecSimPCT.m

* Fix image bug in PTO-Sim in Library Browser (#896)

Co-authored-by: Kelley Ruehl <kmruehl@sandia.gov>
Co-authored-by: Matthieu Ancellin <31126826+mancellin@users.noreply.github.com>
Co-authored-by: jtgrasb <87095491+jtgrasb@users.noreply.github.com>
Co-authored-by: Mathew Topper <damm_horse@yahoo.co.uk>
Co-authored-by: Ahmed Rashid <32479811+ahmedmetin@users.noreply.github.com>
Co-authored-by: Lermart96 <anders.brandt@oceanharvesting.com>
Co-authored-by: yuyihsiang <yyu@nycu.edu.tw>
Co-authored-by: Jorge Leon <72461917+jleonqu@users.noreply.github.com>
@H0R5E H0R5E deleted the ci_docs_check_and_build branch July 25, 2022 10:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation related to docs Tests/CI related WEC-Sim tests or Continuous Integration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants