Skip to content

Commit b4a2edc

Browse files
committed
website: re-generate commons
1 parent 55e992b commit b4a2edc

File tree

127 files changed

+5368
-4173
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+5368
-4173
lines changed

website/blog/_common/_deprecation-notices-glib-2.27.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Support for RedHat 7 was dropped in 2022.
1313

1414
### 32-bit support
1515

16-
Support for 32-bit x86 GNU/Linux and x86 Windows was
16+
Support for 32-bit x64 GNU/Linux and x64 Windows was
1717
dropped in 2022.
1818

1919
### Pre-deprecation notice for 32-bit Arm GNU/Linux

website/blog/_common/_deprecation-notices-glib-2.28.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,16 @@ Support for Ubuntu 18 was dropped in 2025.
1414

1515
### 32-bit support
1616

17-
Support for 32-bit x86 GNU/Linux and x86 Windows was
17+
Support for 32-bit x64 GNU/Linux and x64 Windows was
1818
dropped in 2022 and for 32-bit Arm GNU/Linux in 2025.
19+
20+
### Pre-deprecation notice for x64 macOS
21+
22+
Apple has discontinued support for the x64 (Intel) architecture.
23+
GitHub will no longer support this architecture on macOS after the
24+
macOS 15 runner image is retired in **November 2027**; building
25+
and testing x64 macOS binaries will become more difficult, requiring
26+
a self-hosted runner, and cannot be guaranteed in the long term.
27+
28+
You should begin migrating your projects to arm64-based (Apple Silicon)
29+
binaries to prepare for this possible deprecation.

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

Lines changed: 10 additions & 7 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}}
@@ -31,9 +31,13 @@ download_url: https://github.com/xpack-dev-tools/bash-xpack/releases/tag/v{{xpac
3131
import {PageMetadata} from '@docusaurus/theme-common';
3232
import Image from '@theme/IdealImage';
3333
import CodeBlock from '@theme/CodeBlock';
34+
import Tabs from '@theme/Tabs';
35+
import TabItem from '@theme/TabItem';
3436

35-
import Prerequisites from './_common/_prerequisites-glib-2.27.mdx';
36-
import DeprecationNotices from './_common/_deprecation-notices-glib-2.27.mdx';
37+
import customField from '@site/src/libs/customField';
38+
39+
import Prerequisites from './_common/_prerequisites-glib-2.28.mdx';
40+
import DeprecationNotices from './_common/_deprecation-notices-glib-2.28.mdx';
3741
import DownloadAnalytics from './_common/_download-analytics.mdx';
3842

3943
Version **{{releaseVersion}}** is a new release; it follows the upstream release."
@@ -48,13 +52,13 @@ is a standalone cross-platform binary distribution of
4852

4953
There are separate binaries for **Windows** (x64),
5054
**macOS** (x64 and arm64)
51-
and **GNU/Linux** (x64, arm64 and arm).
55+
and **GNU/Linux** (x64 and arm64).
5256

5357
:::note Raspberry Pi
5458

5559
The main targets for the GNU/Linux Arm
56-
binaries are the **Raspberry Pi** class devices (armv7l and aarch64;
57-
armv6 is not supported).
60+
binaries are the **Raspberry Pi** class devices (aarch64 only;
61+
armv6 and armv7l are no longer supported).
5862

5963
:::
6064

@@ -127,7 +131,6 @@ Before publishing, a set of simple tests were performed on an exhaustive
127131
set of platforms. The results are available from:
128132

129133
- [GitHub Actions](https://github.com/xpack-dev-tools/bash-xpack/actions/)
130-
- [Travis CI](https://app.travis-ci.com/github/xpack-dev-tools/bash-xpack/builds/)
131134

132135
## Tests
133136

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/_branches-details.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
<details>
77
<summary>Branches</summary>
88

9-
The project uses multiple branches:
9+
This project utilises multiple branches:
1010

1111
- `master`, not actively used
12-
- `xpack`, with the latest stable version (default)
13-
- `xpack-development`, with the current development version
14-
- `website`, with the current content of the website; pushes to this branch automatically trigger publishes the main website
15-
- `development`, with the current content of the preview website; pushes to this branch automatically trigger publishes the preview website
12+
- `xpack`, containing the latest stable version (default)
13+
- `xpack-development`, containing the current development version
14+
- `website`, containing the current website content; pushes to this branch automatically trigger publication of the main website
15+
- `development`, containing the current preview website content; pushes to this branch automatically trigger publication of the preview website
1616

17-
All development is done in the `xpack-development` branch, and contributions via
17+
All development is conducted in the `xpack-development` branch, and contributions via
1818
Pull Requests should be directed to this branch.
1919

2020
When new releases are published, the `xpack-development` branch is merged

website/docs/_common/_build-website-locally.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55

66
### Build the static website locally
77

8-
Validate the website content in a local build via the npm **build** script:
8+
Validate the website content by performing a local build using the npm **build** script:
99

1010
```sh
11-
npm run build -C website
11+
npm run build -C ~/Work/xpack-dev-tools/bash-xpack.git/website
1212
```
1313

14-
Fix any broken links, if any.
14+
Resolve any broken links that may be identified during the build process.

website/docs/_common/_code-formatting.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@
55

66
## Code formatting
77

8-
As formatting style, the library uses a
8+
For formatting style, the library employs a
99
[.clang-format](https://clang.llvm.org/docs/ClangFormat.html)
1010
configuration file based on the GNU style.
1111

12-
Code formatting is done using `clang-format --style=file`, either manually
13-
from a script, or automatically from Visual Studio Code, or the Eclipse
12+
Code formatting is performed using `clang-format --style=file`, either manually
13+
via a script, or automatically through Visual Studio Code, or the Eclipse
1414
CppStyle plug-in.
1515

1616
:::info
1717

18-
Visual Studio Code can directly utilise the `.clang-format` file in the
18+
Visual Studio Code can directly utilise the `.clang-format` file within the
1919
**Format Document** command.
2020

2121
:::
2222

2323
:::tip
2424

25-
Always reformat the source files that were changed before committing
25+
Always reformat the source files that have been modified before committing
2626
them to the repository.
2727

2828
:::

website/docs/_common/_continuous-integration.mdx

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33

44
{/* ------------------------------------------------------------------------ */}
55

6-
The library is
7-
CI tested on every push via
8-
[GitHub Actions](https://github.com/xpack-dev-tools/bash-xpack/actions),
9-
on Ubuntu, macOS, and Windows.
6+
The library is subject to continuous integration (CI) testing with every
7+
push utilising [GitHub Actions](https://github.com/xpack-dev-tools/bash-xpack/actions).
8+
This ensures compatibility and stability across Ubuntu, macOS, and Windows
9+
operating systems.
1010

11-
The tests run on 32 and 64-bit bare-metal platforms (Arm Cortex-M0,
12-
Cortex-M3, Cortex-M4F, Cortex-M7F, Cortex-A15, Cortex-A72, RISC-V RV32IMAC,
13-
RV64IMAFDC), and natively, with GCC and LLVM/clang.
11+
Testing is conducted on both 32-bit and 64-bit bare-metal platforms,
12+
including Arm Cortex-M0, Cortex-M3, Cortex-M4F, Cortex-M7F, Cortex-A15,
13+
Cortex-A72, RISC-V RV32IMAC, and RV64IMAFDC. Additionally, native
14+
testing is performed utilising GCC and LLVM/clang compilers, ensuring
15+
comprehensive validation across various environments.

website/docs/_common/_generate-top-commons.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55

66
### Generate the top commons
77

8-
Run the top **generate-top-commons** npm script to update the
8+
Execute the top **generate-top-commons** npm script to update the
99
`build-assets/package.json` and the GitHub workflow files.
1010

1111
```sh
12-
(cd ~/Work/xpack-dev-tools/bash-xpack.git; npm run generate-top-commons)
12+
npm run generate-top-commons -C ~/Work/xpack-dev-tools/bash-xpack.git
1313
```
1414

1515
### Commit the top changes
1616

17-
- stage GitHub workflows and `package.json` files (top and from `build-assets`)
18-
- **commit** with the message _**re-generate top commons to bump deps**_
17+
- Stage GitHub workflows and `package.json` files (top and from `build-assets`)
18+
- **Commit** with the message _**re-generate top commons**_

website/docs/_common/_generate-website-commons.mdx

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,16 @@
33

44
{/* ------------------------------------------------------------------------ */}
55

6-
### Update the website commons
6+
### Generate the website commons
77

8-
Run the **generate-website-commons** npm script from `website/package.json`
9-
in the project folder.
8+
Execute the **generate-website-commons** npm script from `website/package.json`
9+
within the project folder.
1010

1111
```sh
12-
npm run generate-website-commons -C website
12+
npm run generate-website-commons -C ~/Work/xpack-dev-tools/bash-xpack.git/website
1313
```
14+
15+
### Commit the website changes
16+
17+
- Stage the `website` folder and top `README.md`
18+
- **Commit** with the message _**re-generate website commons**_

0 commit comments

Comments
 (0)