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

Bugfix: Check the return status of the "make clean html" command in build_documentation.sh #179

Open
7 of 22 tasks
jprestop opened this issue Feb 2, 2023 · 0 comments
Open
7 of 22 tasks
Assignees
Labels
component: build process Build process issue component: documentation Documentation issue priority: high High Priority reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team type: bug Fix something that is not working

Comments

@jprestop
Copy link
Collaborator

jprestop commented Feb 2, 2023

Describe the Problem

Check the return status of the "make html" command in build_documentation.sh. Currently, the GHA jobs still succeeds since we fail to return bad status from that script.

make clean html
if [ $? != 0 ]; then
  echo "ERROR: make clean html failed"
  exit 1
fi
cd -

See example here.

Also consider adding the following:

  echo ERROR: Warnings/Errors found in documentation
  echo Summary:
  grep WARNING ${DOCS_DIR}/_build/warnings.log
  grep ERROR ${DOCS_DIR}/_build/warnings.log
  grep CRITICAL ${DOCS_DIR}/_build/warnings.log
  echo Review this log file or download documentation_warnings.log artifact

and

echo INFO: Documentation was built successfully.

See example here.

Expected Behavior

If "make clean html" returns a bad status, the GHA runs should also fail.

Environment

Describe your runtime environment:
1. Machine: (e.g. HPC name, Linux Workstation, Mac Laptop)
2. OS: (e.g. RedHat Linux, MacOS)
3. Software version number(s)
N/A

To Reproduce

Describe the steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
Post relevant sample data following these instructions:
https://dtcenter.org/community-code/model-evaluation-tools-met/met-help-desk#ftp

Relevant Deadlines

ASAP

Funding Source

Split 2702691 and 2792542

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Organization level Project for support of the current coordinated release
  • Select Repository level Project for development toward the next official release or add alert: NEED PROJECT ASSIGNMENT label
  • Select Milestone as the next bugfix version

Define Related Issue(s)

Consider the impact to the other METplus components.

Bugfix Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of main_<Version>.
    Branch name: bugfix_<Issue Number>_main_<Version>_<Description>
  • Fix the bug and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into main_<Version>.
    Pull request: bugfix <Issue Number> main_<Version> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Organization level software support Project for the current coordinated release
    Select: Milestone as the next bugfix version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Complete the steps above to fix the bug on the develop branch.
    Branch name: bugfix_<Issue Number>_develop_<Description>
    Pull request: bugfix <Issue Number> develop <Description>
    Select: Reviewer(s) and Development issue
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Close this issue.
@jprestop jprestop added alert: NEED ACCOUNT KEY Need to assign an account key to this issue priority: high High Priority type: bug Fix something that is not working component: build process Build process issue component: documentation Documentation issue requestor: METplus Team METplus Development Team labels Feb 2, 2023
@jprestop jprestop added this to the METdataio-2.0 milestone Feb 2, 2023
@jprestop jprestop self-assigned this Feb 2, 2023
@jprestop jprestop added reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project and removed alert: NEED ACCOUNT KEY Need to assign an account key to this issue labels Feb 2, 2023
@jprestop jprestop changed the title Check the return status of the "make clean html" command in build_documentation.sh Bugfix: Check the return status of the "make clean html" command in build_documentation.sh Feb 2, 2023
@bikegeek bikegeek modified the milestones: METdataio-2.0, METdataio 2.1.0-beta2 Mar 1, 2023
@JohnHalleyGotway JohnHalleyGotway modified the milestones: METdataio 2.1.0-beta2, METdataio-2.1.0 Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: build process Build process issue component: documentation Documentation issue priority: high High Priority reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team type: bug Fix something that is not working
Projects
Status: 🟢 Ready
Development

No branches or pull requests

3 participants