Skip to content

Commit 1deacbb

Browse files
committed
website: re-generate commons
1 parent e5787c5 commit 1deacbb

File tree

10 files changed

+1222
-739
lines changed

10 files changed

+1222
-739
lines changed

website/blog/_templates/blog-post-release-part-1-liquid.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
title: xPack {{packageConfig.descriptiveName}} v{{xpackVersion}} released
44
seo_title: Version {{xpackVersion}} released
5-
description: Version {{xpackVersion}} is a TODO new/maintenance release.
5+
description: Version {{xpackVersion}} is a TODO maintenance/new release.
66
keywords:
77
- xpack
88
- {{packageConfig.permalinkName}}
@@ -34,6 +34,10 @@ download_url: https://github.com/xpack-dev-tools/windows-build-tools-xpack/relea
3434
import {PageMetadata} from '@docusaurus/theme-common';
3535
import Image from '@theme/IdealImage';
3636
import CodeBlock from '@theme/CodeBlock';
37+
import Tabs from '@theme/Tabs';
38+
import TabItem from '@theme/TabItem';
39+
40+
import customField from '@site/src/libs/customField';
3741

3842
import Prerequisites from './_common/_prerequisites-glib-2.28.mdx';
3943
import DeprecationNotices from './_common/_deprecation-notices-glib-2.28.mdx';
@@ -128,7 +132,7 @@ set of platforms. The results are available from:
128132

129133
## Tests
130134

131-
The binaries were testes on Windows 10 Pro 32/64-bit.
135+
The binaries were testes on x64 Windows.
132136

133137
Install the package with xpm.
134138

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,78 @@
11

2+
## Folders hierarchy
3+
4+
After install, the package creates a hierarchy of folders like the following
5+
(only the first two depth levels are shown):
6+
7+
{%- assign platforms_array = platforms | split: "," %}
8+
9+
{%- assign names_array = "" | split: "" %}
10+
11+
{%- for platform in platforms_array %}
12+
{%- case platform %}
13+
{%- when "win32-x64" %}
14+
{%- assign names_array = names_array | concat: "Windows" %}
15+
{%- when "darwin-x64", "darwin-arm64" %}
16+
{%- assign names_array = names_array | concat: "macOS" %}
17+
{%- when "linux-x64", "linux-arm64", "linux-arm" %}
18+
{%- assign names_array = names_array | concat: "GNU/Linux" %}
19+
{%- endcase %}
20+
{%- endfor %}
21+
22+
{%- assign names_array = names_array | uniq %}
23+
24+
<Tabs groupId="operating-systems">
25+
26+
{%- for name in names_array %}
27+
{%- case name %}
28+
{%- when "Windows" %}
29+
30+
<TabItem value="windows" label="Windows" default>
31+
32+
<CodeBlock language="console"> {
33+
`C:\> tree /f %USERPROFILE%\\AppData\\Roaming\\xPacks\\@{{packageScope}}\\{{packageName}}\\${frontMatter.version}.${frontMatter.npm_subversion}\\.content
34+
Folder PATH listing
35+
Volume serial number is B02D-925C
36+
├── README.md
37+
├── bin
38+
TODO
39+
`} </CodeBlock>
40+
41+
</TabItem>
42+
43+
{%- when "macOS" %}
44+
45+
<TabItem value="macos" label="macOS">
46+
47+
<CodeBlock language="console"> {
48+
`$ tree -L 2 ~/Library/xPacks/\{{packageScopedName}}/${frontMatter.version}.${frontMatter.npm_subversion}/.content/
49+
/Users/ilg/Library/xPacks/\{{packageScopedName}}/${frontMatter.version}.${frontMatter.npm_subversion}/.content/
50+
├── README.md
51+
├── bin
52+
TODO
53+
`} </CodeBlock>
54+
55+
</TabItem>
56+
57+
{%- when "GNU/Linux" %}
58+
59+
<TabItem value="linux" label="GNU/Linux">
60+
61+
<CodeBlock language="console"> {
62+
`$ tree -L 2 ~/.local/xPacks/\{{packageScopedName}}/${frontMatter.version}.${frontMatter.npm_subversion}/.content/
63+
/home/ilg/.local/xPacks/\{{packageScopedName}}/${frontMatter.version}.${frontMatter.npm_subversion}/.content/
64+
├── README.md
65+
├── bin
66+
TODO
67+
`} </CodeBlock>
68+
69+
</TabItem>
70+
71+
{%- endcase %}
72+
{%- endfor %}
73+
74+
</Tabs>
75+
276
<DeprecationNotices/>
377

478
<DownloadAnalytics version={frontMatter.version}/>

website/docs/_common/_publish-website.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ The website deployment is performed automatically when pushing to the
1010
[GitHub Actions](https://github.com/xpack-dev-tools/windows-build-tools-xpack/actions/workflows/publish-github-pages.yml).
1111

1212
- Open https://xpack-dev-tools.github.io/windows-build-tools-xpack/docs/maintainer/#publish-the-website in a separate window
13-
- Stop the local web server
13+
- **Stop** the local web server
1414
- Switch to the `website` branch
1515
- **Merge** the `xpack-development` branch into the `website` branch
1616
- **Push** the `website` branch to GitHub
1717
:::info
1818
At this point, an automated GitHub Action will generate and publish the website.
1919
:::
2020
- Check out the `xpack-development` branch
21-
- Wait for the publication to complete
22-
- Refresh the web page
21+
- **Wait** for the publication to complete
22+
- **Refresh** the web page
2323
- The new release blog post is available
2424
at https://xpack-dev-tools.github.io/windows-build-tools-xpack/blog/
2525
- Record the post URL, as it must be used to update the release page

website/docs/install/_common/_content.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ the project build configurations need a PATH adjustment:
280280
<TabItem value="windows" label="Windows" default>
281281

282282
<CodeBlock language="sh"> {
283-
`export PATH=$HOME/AppData/Roaming/xPacks/xpack-dev-tools/windows-build-tools/4.4.1-3.1/.content/bin:$PATH
283+
`export PATH=$HOME/AppData/Roaming/xPacks/@xpack-dev-tools/windows-build-tools/4.4.1-3.1/.content/bin:$PATH
284284
`} </CodeBlock>
285285

286286
:::tip

website/docs/maintainer/_common/_content.mdx

Lines changed: 7 additions & 30 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
@@ -203,9 +190,11 @@ Commit with the message _**website: update development durations**_
203190
Copy the trees displayed at the end of the test builds and paste to the
204191
**Folder hierarchy** section within the web file:
205192

193+
<ul>
206194

207195

208-
- `website/docs/_project/_folders-hierarchies-windows.mdx`
196+
<li> <code>website/docs/_project/_folders-hierarchies-windows.mdx</code></li>
197+
</ul>
209198

210199
If present, replace the actual version
211200
(such as **4.4.1-3.1**) with the following expression:
@@ -251,7 +240,7 @@ place them in the XBB cache (`Work/cache`) and restart the build.
251240

252241
## Execute the production builds
253242

254-
The automation is provided by GitHub Actions.
243+
The automation is provided by GitHub Actions on GitHub-hosted runners.
255244

256245
### Publish the helper
257246

@@ -316,7 +305,7 @@ The resulting binaries are available for testing from
316305

317306
### Automated tests
318307

319-
The automation is provided by GitHub Actions.
308+
The automation is provided by GitHub Actions on GitHub-hosted runners.
320309

321310
To trigger the GitHub Actions tests, execute the xpm actions:
322311

@@ -352,11 +341,6 @@ xpm run install -C ~/Work/xpack-dev-tools/windows-build-tools-xpack.git/build-as
352341
xpm run test-pre-release -C ~/Work/xpack-dev-tools/windows-build-tools-xpack.git/build-assets
353342
```
354343

355-
:::caution
356-
Since the builds were performed on the latest GitHub macOS runners,
357-
it is strongly recommended to also execute the tests on an older macOS 11 machine.
358-
:::
359-
360344
For additional tests, on each platform,
361345
download the archive from
362346
[pre-releases/test](https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/)
@@ -402,17 +386,10 @@ watching the windows-build-tools-xpack project.
402386

403387
<CommonPrepareNewBlogPost />
404388

405-
### Update the web install page
406-
407-
- Check and possibly update the output of the `--version` runs in
408-
- `website/docs/install/_project/_automatic-install-quick-test.mdx`
409-
- `website/docs/install/_project/_manual-install-quick-test.mdx`
410-
- **Commit** with the message _**website: update quick tests**_
411-
412389
### Check the list of links in top package.json
413390

414391
- Open the top `package.json` file
415-
- Check if the links in the `bin` property cover the actual binaries
392+
- Check if the links in the `xpack.executables` property cover the actual binaries
416393
- If necessary, also check on Windows
417394

418395
### Update the package.json list of binaries
@@ -446,7 +423,7 @@ Execute the **trigger-workflow-test-xpm** xpm action:
446423
xpm run trigger-workflow-test-xpm -C ~/Work/xpack-dev-tools/windows-build-tools-xpack.git/build-assets
447424
```
448425

449-
This will install the package via `xpm install` on all supported platforms.
426+
This will test if the package can be installed via `xpm install` on all supported platforms.
450427

451428
The test results are available from the
452429
[GitHub Actions](https://github.com/xpack-dev-tools/windows-build-tools-xpack/actions) page.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
import versionMajor from '@site/src/libs/versionMajor';
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
The strategy with the development builds is to run them in descending order
7+
({versionMajor()}.2, {versionMajor() - 1}.3, {versionMajor() - 2}.4, {versionMajor() - 3}.5).
8+
9+
For this update the top `package.json` and `build-assets/scripts/VERSION` files
10+
and run the build scripts.
11+
12+
After each build, save the folder hierarchies and executables, to be used
13+
in the blog posts.
14+
15+
Then perform the steps to make the production builds in ascending order
16+
({versionMajor() - 3}.5, {versionMajor() - 2}.4, {versionMajor() - 1}.3, {versionMajor()}.2),
17+
with full tests and website updates.

website/docs/maintainer/_common/_prepare-new-blog-post.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
```sh
1111
npm run generate-website-blog-post -C ~/Work/xpack-dev-tools/windows-build-tools-xpack.git/website
1212
```
13-
- Edit the front matter properties (the `description` property)
14-
- Select the correct summary (maintenance vs. new release)
13+
- Fix the TODO in the front matter `description` property (select maintenance vs. new release)
14+
- Fix the TODO in the summary (select maintenance vs. new release)
1515
- Add entries in the **Bug fixes**; utilise the following syntax
1616
```
1717
- [[#N](https://github.com/xpack-dev-tools/windows-build-tools-xpack/issues/N)]:
1818
```
19-
- Copy/paste the folder structures from the installation guide
19+
- Copy/paste the **folder hierarchies** from the `website/docs/_project/_folders-hierarchies-*.mdx` files
2020
- **Commit** with the message _**website: blog post release 4.4.1-3.1 published**_

website/docusaurus.config.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ const config: Config = {
4747

4848
onBrokenAnchors: 'throw',
4949
onBrokenLinks: 'throw',
50-
onBrokenMarkdownLinks: 'throw',
5150

5251
onDuplicateRoutes: 'throw',
5352

@@ -64,7 +63,10 @@ const config: Config = {
6463
},
6564

6665
markdown: {
67-
format: 'detect'
66+
format: 'detect',
67+
hooks: {
68+
onBrokenMarkdownLinks: 'throw'
69+
}
6870
},
6971

7072
plugins: [

0 commit comments

Comments
 (0)