Skip to content

Check for missing dependencies before building the website#1678

Merged
sonichi merged 1 commit intomicrosoft:mainfrom
gunnarku:enhance-web-site-building
Feb 16, 2024
Merged

Check for missing dependencies before building the website#1678
sonichi merged 1 commit intomicrosoft:mainfrom
gunnarku:enhance-web-site-building

Conversation

@gunnarku
Copy link
Copy Markdown
Contributor

Summary:

  • Add an executable permission to the file.
  • Check for the dependencies before the website build starts.
  • Output a list of missing dependencies.
  • Note: command -v is POSIX compatible.

Sample output:

$ ./build_website.sh
Command 'pydoc-markdown' not found.
Command 'python' not found.

Some of the dependencies are missing.
Please install them to build the website.

Why are these changes needed?

TL;DR: make the life of anyone who wants to contribute to the documentation (and doesn't necessary run all the steps described in README.md ;-)) easier. My workflow consisted of 5-6 retries till I got all the dependencies right. This set of changes reduces the frustration and performs the dependency checks beforehand.

Related issue number

Checks

 - Add an executable permission to the file.
 - Check for dependencies before the build starts.
 - Output a list of missing dependencies.
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (71829f3) 37.80% compared to head (1306610) 37.80%.
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1678   +/-   ##
=======================================
  Coverage   37.80%   37.80%           
=======================================
  Files          50       50           
  Lines        5726     5726           
  Branches     1296     1296           
=======================================
  Hits         2165     2165           
  Misses       3390     3390           
  Partials      171      171           
Flag Coverage Δ
unittests 37.80% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ekzhu ekzhu requested a review from jackgerrits February 14, 2024 18:33
Copy link
Copy Markdown
Contributor

@jackgerrits jackgerrits left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@sonichi sonichi added this pull request to the merge queue Feb 16, 2024
Merged via the queue into microsoft:main with commit bf3cc0f Feb 16, 2024
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
…#1678)

- Add an executable permission to the file.
 - Check for dependencies before the build starts.
 - Output a list of missing dependencies.
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.

4 participants