diff --git a/website/docs/developer/_manual-tests.mdx b/website/docs/developer/_more.mdx similarity index 100% rename from website/docs/developer/_manual-tests.mdx rename to website/docs/developer/_more.mdx diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx index c5367b9..6838741 100644 --- a/website/docs/developer/index.mdx +++ b/website/docs/developer/index.mdx @@ -16,7 +16,7 @@ import customField from '@site/src/libs/customField'; import PlatformNativeSection from './_common/_platform-native-section.mdx' import PlatformDockerSection from './_common/_platform-docker-section.mdx' import OtherRepositories from './_other-repositories.mdx'; -import ManualTests from './_manual-tests.mdx' +import More from './_more.mdx' {/* ------------------------------------------------------------------------ */} @@ -322,4 +322,4 @@ locations (like https://github.com/xpack-dev-tools/files-cache/tree/master/libs), place them in the XBB cache (`Work/cache`) and restart the build. - + diff --git a/website/docs/getting-started/_more.mdx b/website/docs/getting-started/_more.mdx new file mode 100644 index 0000000..2a39939 --- /dev/null +++ b/website/docs/getting-started/_more.mdx @@ -0,0 +1,2 @@ + +{/* ------------------------------------------------------------------------ */} diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx index c5aa454..4a1a9a1 100644 --- a/website/docs/getting-started/index.mdx +++ b/website/docs/getting-started/index.mdx @@ -14,6 +14,7 @@ import UpgradeNotice from './_upgrade-notice.mdx'; import Compatibility from './_compatibility.mdx'; import Documentation from './_documentation.mdx' import ReleaseSchedule from './_release-schedule.mdx' +import More from './_more.mdx' {/* ------------------------------------------------------------------------ */} @@ -109,7 +110,7 @@ For additional information, please refer to the The release and change log is available in the repository [`CHANGELOG.md`](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/blob/xpack/CHANGELOG.md) file. -## Maintainer & Developer info +## Maintainer & Developer information For information on the workflow used to make releases, please see the [Maintainer Info](/docs/maintainer/) page. @@ -136,3 +137,5 @@ corresponding licenses are available in each archive in the ## Releases The list of releases is available in the [Releases](/docs/releases/) pages. + + diff --git a/website/docs/maintainer/_check-upstream-release.mdx b/website/docs/maintainer/_check-upstream-release.mdx index 8f86ee0..bdc26af 100644 --- a/website/docs/maintainer/_check-upstream-release.mdx +++ b/website/docs/maintainer/_check-upstream-release.mdx @@ -1,11 +1,6 @@ -{/* ------------------------------------------------------------------------ */} +import GccCheckUpstreamRelease from './_common/_gcc-check-upstream-release.mdx'; -### Check the latest upstream release +{/* ------------------------------------------------------------------------ */} -The current release must be announced in the -[GCC Timeline](https://gcc.gnu.org/releases.html) page. -Compare the latest release with the current xPack -[release](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases). -If necessary, update the triplet, otherwise increase the fourth number, -as below. + diff --git a/website/docs/maintainer/_common/_gcc-check-upstream-release.mdx b/website/docs/maintainer/_common/_gcc-check-upstream-release.mdx new file mode 100644 index 0000000..3504869 --- /dev/null +++ b/website/docs/maintainer/_common/_gcc-check-upstream-release.mdx @@ -0,0 +1,16 @@ +{/* DO NOT EDIT! */} +{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} + +{/* ------------------------------------------------------------------------ */} + +### Check the latest upstream release + +The current release must be announced in the +[GCC Timeline](https://gcc.gnu.org/releases.html) page. +Compare the latest GCC release with the current xPack +[release](https://github.com/xpack-dev-tools/gcc-xpack/releases). + +If necessary, update the triplet, otherwise increase the fourth number, +as below. + +The actual version is in the `gcc.git/gcc/BASE-VER` file. diff --git a/website/docs/maintainer/_functional-tests.mdx b/website/docs/maintainer/_more-tests.mdx similarity index 100% rename from website/docs/maintainer/_functional-tests.mdx rename to website/docs/maintainer/_more-tests.mdx diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx index e855052..4a894a1 100644 --- a/website/docs/maintainer/index.mdx +++ b/website/docs/maintainer/index.mdx @@ -18,7 +18,7 @@ import ReleaseSchedule from './_release-schedule.mdx'; import CheckUpstreamRelease from './_check-upstream-release.mdx' import UpdateVersionSpecific from './_update-version-specific.mdx' import GitHubActionsDurations from './_github-actions-durations.mdx' -import FunctionalTests from './_functional-tests.mdx' +import MoreTests from './_more-tests.mdx' import ShareCustom from './_share-custom.mdx' import { developmentDurations } from './_development-durations.mdx' @@ -326,7 +326,7 @@ Copy the trees displayed at the end of the test builds and paste to - `website/docs/install/_miscellaneous.mdx` Replace **{ customField('upstreamVersion') }** with -`${ customField('upstreamVersion') }` (there must be 6 occurences). +`${ customField('upstreamVersion') }`. :::tip @@ -505,9 +505,12 @@ These commands use the `xpack-development` branch of this repo. -The workflow result and logs are available from the +The workflow results and logs are available from the [GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions/) page. +Update the values in `website/docs/maintainer/_github-actions-durations.mdx` +with those shown by GitHub Actions. + The resulting binaries are available for testing from [pre-releases/test](https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/). @@ -519,8 +522,6 @@ The automation is provided by GitHub Actions. To trigger the GitHub Actions tests, run the xPack actions: -use the xPack actions: - - **trigger-workflow-test-prime** - **trigger-workflow-test-docker-linux-x64** - **trigger-workflow-test-docker-linux-arm** @@ -541,6 +542,11 @@ binaries. The tests results are available from the [GitHub Actions](https://github.com/xpack-dev-tools/openocd-xpack/actions/) page. +After running the prime tests, download the test results and compare +with previous runs. + +#### More macOS tests + Since GitHub Actions provides a limited range of versions for the macOS runner, the multi-version macOS tests run on Travis. @@ -578,7 +584,7 @@ On macOS, remove the `com.apple.quarantine` flag: xattr -cr ${HOME}/Downloads/xpack-* ``` - + ## Publish the release @@ -709,6 +715,16 @@ This will install the package via `xpm install` on all supported platforms. The tests results are available from the [GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions/) page. +### Copy the test results + +For the toolchain projects, download the `test-report.zip` file, unzip it +and copy the markdown file to `website/docs/tests`. + +Edit the `website/docs/tests/index.md` file to add the +new page. + +Commit with _**website: add tests results**_. + ### Tag the npm package as `latest` When the release is considered stable, promote it as `latest`: @@ -725,6 +741,14 @@ In case the previous version is not functional and needs to be unpublished: `npm unpublish @xpack-dev-tools/riscv-none-elf-gcc@${ customField('upstreamVersion') }-${ customField('xpackSubversion') }.${ customField('npmSubversion') }` } +### Build the static website locally + +Validate the web site content in a local build via the npm `build` script: + +```sh +npm --prefix website run build +``` + ### Update the repo & publish the website - merge `xpack-development` into `xpack` diff --git a/website/sidebars.ts b/website/sidebars.ts index 2db51f2..cc95863 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -44,6 +44,11 @@ const sidebars: SidebarsConfig = { id: 'support/index', label: 'Help Centre' }, + { + type: 'doc', + id: 'releases/index', + label: 'Releases' + }, { type: 'doc', id: 'developer/index', @@ -54,11 +59,6 @@ const sidebars: SidebarsConfig = { id: 'maintainer/index', label: 'Maintainer Information' }, - { - type: 'doc', - id: 'releases/index', - label: 'Releases' - } ], };