[github-actions]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@alauda/doom@2.9.0

Minor Changes

• #364 d02c46f Thanks @youyongsong! - Make the Jira that release notes are fetched from configurable, with JIRA_BASE_URL.

  A release-notes-for-bugs placeholder is filled from Jira's search API, and the
  address of that API was written into the code — https://jira.alauda.cn/rest/api/2/search
  — while only the credentials, JIRA_USERNAME and JIRA_PASSWORD, came from the
  environment. A build that can reach Jira only through another host or port had no
  way to say so, and a production build fails when it cannot fetch its release notes.

  JIRA_BASE_URL is the Jira base URL: the scheme, the host, an optional port and an
  optional context path, without /rest/.... doom appends /rest/api/2/search to it.
  A trailing / is ignored, and an empty value counts as unset, which is the shape an
  unset variable often arrives in. It is read for each request rather than when the
  module loads, so it does not matter when the plugin was first imported.

  Unset, the request is byte for byte the one doom sent before, so nothing changes for
  a build that does not set it.

Patch Changes

• #365 26b6b4f Thanks @youyongsong! - Only a supported language's directory is a language. Any other directory under
  the docs root is now skipped with a warning instead of failing the build.

  Every directory directly under the docs root used to become a language, apart
  from dist, node_modules, public and shared. Each language gets a
  /<lang>/products page whose heading comes from doom's word list, and the word
  list only has en, zh and ru. So when tektoncd-operator added a shell
  script under docs/scripts/, scripts became a language, and every docs build
  of both its branches failed from then on (65 runs over two days, none green)
  with an error that says nothing about the directory:

  Page "/scripts/products" SSG rendering failed.
  TypeError: Cannot read properties of undefined (reading 'all_product_documentation')
  

  Nor could a site work around it: there is no option to name the languages, and
  a themeConfig.locales list in the config is appended to the detected one
  rather than replacing it.

  A directory is now a language only if its name is one of
  SUPPORTED_LANGUAGES, the list doom lint and doom translate already use.
  Any other directory is left out of the site the way shared/ is — none of its
  files becomes a page — and the build says which one it skipped:

  Skipped `docs/scripts`: not a language directory (doom builds en, zh, ru), so no pages are built from it, like `shared`
  

  -I / -E still pick the languages first; a directory they leave out is
  skipped silently, as before. The same rule covers a directory of pages in a
  language doom does not support, such as docs/ja/: its pages are not built, and
  the warning is the only sign of it.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.94%. Comparing base (26b6b4f) to head (8539eba).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #366   +/-   ##
=======================================
  Coverage   66.94%   66.94%           
=======================================
  Files         100      100           
  Lines        3903     3903           
  Branches     1152     1152           
=======================================
  Hits         2613     2613           
  Misses       1026     1026           
  Partials      264      264           

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.