Skip to content

Commit 210a74b

Browse files
committed
website update
1 parent 77c3b63 commit 210a74b

File tree

2 files changed

+14
-145
lines changed

2 files changed

+14
-145
lines changed

website/docs/maintainer/_common/_content.mdx

Lines changed: 14 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -154,19 +154,6 @@ triggered via the VS Code graphical interface, utilising the
154154

155155
<ProjectPatches/>
156156

157-
### Restart the Docker daemons
158-
159-
If, for any reason, the Docker builds need to be cancelled, it is very
160-
likely that some processes will continue to execute in the background.
161-
162-
To completely terminate them, and ensure that Docker executes
163-
from a clean slate, restart the Docker daemons on all GNU/Linux
164-
machines:
165-
166-
```sh
167-
sudo systemctl restart docker
168-
```
169-
170157
### Verify if both projects are pushed
171158

172159
Verify that both the **current project** and the **helper** are
@@ -252,27 +239,27 @@ caffeinate ssh xbbli
252239

253240
<CommonPlatformDockerBuild platform="linux-x64"/>
254241

255-
### Build the x64 Windows binaries
242+
### Build the ARM64 GNU/Linux binaries
256243

257-
Execute the Docker build on the production machine (`xbbli`);
244+
Execute the Docker build on the production machine (`ampere`);
258245
start a VS Code remote session, or connect with a terminal:
259246

260247
```sh
261-
caffeinate ssh xbbli
248+
caffeinate ssh ampere
262249
```
263250

264-
<CommonPlatformDockerBuild platform="win32-x64"/>
251+
<CommonPlatformDockerBuild platform="linux-arm64"/>
265252

266-
### Build the ARM64 GNU/Linux binaries
253+
### Build the x64 Windows binaries
267254

268-
Execute the Docker build on the production machine (`ampere`);
255+
Execute the Docker build on the production machine (`xbbli`);
269256
start a VS Code remote session, or connect with a terminal:
270257

271258
```sh
272-
caffeinate ssh ampere
259+
caffeinate ssh xbbli
273260
```
274261

275-
<CommonPlatformDockerBuild platform="linux-arm64"/>
262+
<CommonPlatformDockerBuild platform="win32-x64"/>
276263

277264
### Update the durations of the development builds
278265

@@ -343,71 +330,7 @@ place them in the XBB cache (`Work/cache`) and restart the build.
343330

344331
## Execute the production builds
345332

346-
The automation is provided by GitHub Actions and three self-hosted runners
347-
(the GitHub hosted runners do not have the necessary resources).
348-
349-
### Start the self-hosted runners
350-
351-
If the runners have expired (more than 2 weeks since last use), execute the
352-
`github-runner-configure.sh` script to reconfigure them. This script
353-
is available in the `xbb-helper` and
354-
requires `GITHUB_API_XPACK_DEV_TOOLS_RUNNERS_TOKEN` to be present.
355-
356-
- On the development machine (`wksi`) open
357-
SSH sessions to the build machines (`xbbli`, `xbbmi`, `xbbma`, `ampere`):
358-
359-
```sh
360-
caffeinate ssh xbbli
361-
caffeinate ssh xbbmi
362-
caffeinate ssh xbbma
363-
caffeinate ssh ampere
364-
```
365-
366-
Create a `screen` session, to provide a persistent standard output for
367-
the runners:
368-
369-
```sh
370-
screen -S ga
371-
```
372-
373-
To exit it, use `# Ctrl-a Ctrl-d`.
374-
375-
For `xbbli` & `ampere`, which have additional memory, start two runners:
376-
377-
```sh
378-
~/actions-runners/xpack-dev-tools/1/run.sh &
379-
~/actions-runners/xpack-dev-tools/2/run.sh &
380-
```
381-
382-
For the macOS x64 runners, ensure the deployment target is defined:
383-
384-
```sh
385-
unset WORK_FOLDER_PATH
386-
export XBB_ENVIRONMENT_MACOSX_DEPLOYMENT_TARGET="11.0"
387-
~/actions-runners/xpack-dev-tools/run.sh &
388-
```
389-
390-
On all other machines, start the runner with:
391-
392-
```sh
393-
~/actions-runners/xpack-dev-tools/run.sh &
394-
```
395-
396-
To check the status of the runners locally:
397-
398-
```sh
399-
ps -a | grep 'Runner.Listener'
400-
```
401-
402-
To terminate them:
403-
404-
```sh
405-
killall Runner.Listener
406-
```
407-
408-
### Check the status of the runners
409-
410-
The status of all self-hosted runners is available at the [GitHub Runners](https://github.com/organizations/xpack-dev-tools/settings/actions/runners) page.
333+
The automation is provided by GitHub Actions on GitHub-hosted runners.
411334

412335
### Publish the helper
413336

@@ -420,49 +343,6 @@ to `"@xpack-dev-tools/xbb-helper":`.
420343

421344
<CommonGenerateTopCommons />
422345

423-
### Check for disk space
424-
425-
Verify that the build machines have sufficient free space and perform
426-
cleanup operations as necessary:
427-
428-
```sh
429-
xpm run check-space -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets
430-
```
431-
432-
This is equivalent to executing a `df` command.
433-
434-
<Tabs groupId="operating-systems">
435-
436-
<TabItem value="macos" label="macOS">
437-
438-
```
439-
df -gH /
440-
```
441-
442-
</TabItem>
443-
444-
<TabItem value="linux" label="GNU/Linux">
445-
446-
```sh
447-
df -BG -H /
448-
```
449-
450-
</TabItem>
451-
452-
</Tabs>
453-
454-
To free the space utilised by all previous builds of all `xpack-dev-tools` packages:
455-
456-
```sh
457-
xpm run clear-all-projects-builds -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets
458-
```
459-
460-
This is equivalent to executing a comprehensive `rm` to remove the `build` folders:
461-
462-
```sh
463-
rm -rf ~/Work/xpack-dev-tools/*/build-assets/build
464-
```
465-
466346
### Commit and push
467347

468348
- **Push** the `xpack-development` branch to GitHub
@@ -559,6 +439,11 @@ xpm run install -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-ass
559439
xpm run test-pre-release -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets
560440
```
561441

442+
:::caution
443+
Since the builds were performed on the latest GitHub macOS runners,
444+
it is strongly recommended to also execute the tests on an older macOS 11 machine.
445+
:::
446+
562447
For additional tests, on each platform,
563448
download the archive from
564449
[pre-releases/test](https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/)
@@ -681,19 +566,6 @@ The test results are available from the
681566
- Navigate to https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/
682567
- Remove the test binaries
683568

684-
### Clean the work area
685-
686-
Execute the **trigger-workflow-deep-clean** xpm action:
687-
688-
```sh
689-
xpm run trigger-workflow-deep-clean -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets
690-
```
691-
692-
This will remove the build folders on all self-hosted runners.
693-
694-
The results are available from the
695-
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions) page.
696-
697569
<CommonCloseOpenIssues />
698570

699571
<CommonShareOnTwitter />

website/doxygen/.gitignore

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)