Skip to content

Commit

Permalink
website updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Aug 9, 2024
1 parent 927e31d commit 56aeddb
Show file tree
Hide file tree
Showing 9 changed files with 62 additions and 22 deletions.
File renamed without changes.
4 changes: 2 additions & 2 deletions website/docs/developer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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'

{/* ------------------------------------------------------------------------ */}

Expand Down Expand Up @@ -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.

<ManualTests/>
<More/>
2 changes: 2 additions & 0 deletions website/docs/getting-started/_more.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

{/* ------------------------------------------------------------------------ */}
5 changes: 4 additions & 1 deletion website/docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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'

{/* ------------------------------------------------------------------------ */}

Expand Down Expand Up @@ -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.
Expand All @@ -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.

<More/>
11 changes: 3 additions & 8 deletions website/docs/maintainer/_check-upstream-release.mdx
Original file line number Diff line number Diff line change
@@ -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.
<GccCheckUpstreamRelease/>
16 changes: 16 additions & 0 deletions website/docs/maintainer/_common/_gcc-check-upstream-release.mdx
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
36 changes: 30 additions & 6 deletions website/docs/maintainer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -505,9 +505,12 @@ These commands use the `xpack-development` branch of this repo.

<GitHubActionsDurations/>

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/).

Expand All @@ -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**
Expand All @@ -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.

Expand Down Expand Up @@ -578,7 +584,7 @@ On macOS, remove the `com.apple.quarantine` flag:
xattr -cr ${HOME}/Downloads/xpack-*
```

<FunctionalTests/>
<MoreTests/>

## Publish the release

Expand Down Expand Up @@ -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`:
Expand All @@ -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') }`
} </CodeBlock>

### 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`
Expand Down
10 changes: 5 additions & 5 deletions website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -54,11 +59,6 @@ const sidebars: SidebarsConfig = {
id: 'maintainer/index',
label: 'Maintainer Information'
},
{
type: 'doc',
id: 'releases/index',
label: 'Releases'
}
],
};

Expand Down

0 comments on commit 56aeddb

Please sign in to comment.