Skip to content

Commit

Permalink
website: re-generate commons
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Jan 21, 2025
1 parent f2b8f35 commit 36a43cf
Show file tree
Hide file tree
Showing 11 changed files with 56 additions and 96 deletions.
4 changes: 2 additions & 2 deletions website/docs/developer/_common/_platform-docker-section.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ or, for more verbosity, run the similar development build:
archive and its SHA signature, created in
the <code>build-assets/build/{props.platform}/deploy</code> folder:

- <code>xpack-realpath-{customField('xpackVersion')}-{props.platform}.tar.gz</code>
- <code>xpack-realpath-{customField('xpackVersion')}-{props.platform}.tar.gz.sha</code>
- <code>xpack-realpath-9.5.0-1-{props.platform}.tar.gz</code>
- <code>xpack-realpath-9.5.0-1-{props.platform}.tar.gz.sha</code>

To rerun the build, invoke the **deep-clean** action and repeat from install:

Expand Down
4 changes: 2 additions & 2 deletions website/docs/developer/_common/_platform-native-section.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ or, for more verbosity, run the similar development build:
archive and its SHA signature, created in
the <code>build-assets/build/{props.platform}/deploy</code> folder:

- <code>xpack-realpath-{customField('xpackVersion')}-{props.platform}.tar.gz</code>
- <code>xpack-realpath-{customField('xpackVersion')}-{props.platform}.tar.gz.sha</code>
- <code>xpack-realpath-9.5.0-1-{props.platform}.tar.gz</code>
- <code>xpack-realpath-9.5.0-1-{props.platform}.tar.gz.sha</code>

To rerun the build, invoke the **deep-clean** action and repeat from install:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ To check if the {props.longName} installed by **xpm** starts properly, use somet
<TabItem value="macos" label="macOS">

<CodeBlock language="console"> {
`% ~/Library/xPacks/@xpack-dev-tools/${props.shortName}/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version
${props.branding}${customField('upstreamVersion')}
`% ~/Library/xPacks/@xpack-dev-tools/${props.shortName}/9.5.0-1.1/.content/bin/${props.programName} --version
${props.branding}9.5
`} </CodeBlock>

</TabItem>

<TabItem value="linux" label="GNU/Linux">

<CodeBlock language="console"> {
`$ ~/.local/xPacks/@xpack-dev-tools/${props.shortName}/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version
${props.branding}${customField('upstreamVersion')}
`$ ~/.local/xPacks/@xpack-dev-tools/${props.shortName}/9.5.0-1.1/.content/bin/${props.programName} --version
${props.branding}9.5
`} </CodeBlock>

</TabItem>
Expand Down
8 changes: 4 additions & 4 deletions website/docs/install/_common/_manual-install-quick-test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ To check if the {props.longName} installed manually starts properly, use somethi
<TabItem value="macos" label="macOS">

<CodeBlock language="console"> {
`% ~/Library/xPacks/${props.shortName}/xpack-${props.shortName}-${customField('xpackVersion')}/bin/${props.programName} --version
${props.branding}${customField('upstreamVersion')}
`% ~/Library/xPacks/${props.shortName}/xpack-${props.shortName}-9.5.0-1/bin/${props.programName} --version
${props.branding}9.5
`} </CodeBlock>

</TabItem>

<TabItem value="linux" label="GNU/Linux">

<CodeBlock language="console"> {
`$ ~/.local/xPacks/${props.shortName}/xpack-${props.shortName}-${customField('xpackVersion')}/bin/${props.programName} --version
${props.branding}${customField('upstreamVersion')}
`$ ~/.local/xPacks/${props.shortName}/xpack-${props.shortName}-9.5.0-1/bin/${props.programName} --version
${props.branding}9.5
`} </CodeBlock>

</TabItem>
Expand Down
30 changes: 15 additions & 15 deletions website/docs/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ The command to install the **latest** available version of **realpath** is:
To install a **specific version**, specify it explicitly:

<CodeBlock language="sh"> {
`xpm install @xpack-dev-tools/realpath@${customField('releaseVersion')} --verbose
`xpm install @xpack-dev-tools/realpath@9.5.0-1.1 --verbose
`} </CodeBlock>

<Tabs groupId="operating-systems">
Expand Down Expand Up @@ -349,7 +349,7 @@ The result looks like this:
"dependencies": {},
"devDependencies": {
"@xpack-dev-tools/realpath": {
"specifier": "${customField('xpackVersion')}.${customField('npmSubversion')}",
"specifier": "9.5.0-1.1",
"local": "link",
"platforms": "all"
}
Expand Down Expand Up @@ -405,15 +405,15 @@ the project build configurations need a PATH adjustment:
<TabItem value="macos" label="macOS">

<CodeBlock language="sh"> {
`export PATH=$HOME/Library/xPacks/\@pack-dev-tools/realpath/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin:$PATH
`export PATH=$HOME/Library/xPacks/\@pack-dev-tools/realpath/9.5.0-1.1/.content/bin:$PATH
`} </CodeBlock>

</TabItem>

<TabItem value="linux" label="GNU/Linux">

<CodeBlock language="sh"> {
`export PATH=$HOME/.local/xPacks/@xpack-dev-tools/realpath/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin:$PATH
`export PATH=$HOME/.local/xPacks/@xpack-dev-tools/realpath/9.5.0-1.1/.content/bin:$PATH
`} </CodeBlock>

</TabItem>
Expand Down Expand Up @@ -503,8 +503,8 @@ are packed as `.tar.gz` archives.
Download the latest version named like:

<ul>
<li><code>xpack-realpath-{customField('xpackVersion')}-darwin-x64.tar.gz</code></li>
<li><code>xpack-realpath-{customField('xpackVersion')}-darwin-arm64.tar.gz</code></li>
<li><code>xpack-realpath-9.5.0-1-darwin-x64.tar.gz</code></li>
<li><code>xpack-realpath-9.5.0-1-darwin-arm64.tar.gz</code></li>
</ul>

:::note
Expand All @@ -519,14 +519,14 @@ unpack the archive and move it to a location of your choice.

The recommended location is
the <code>~/Library/xPacks/realpath</code> folder, for
example <code>/Users/ilg/Library/xPacks/realpath/xpack-realpath-{customField('xpackVersion')}</code>:
example <code>/Users/ilg/Library/xPacks/realpath/xpack-realpath-9.5.0-1</code>:

<CodeBlock language="console"> {
`mkdir -p ~/Library/xPacks/realpath
cd ~/Library/xPacks/realpath
tar xvf ~/Downloads/xpack-realpath-${customField('xpackVersion')}-darwin-x64.tar.gz
chmod -R -w xpack-realpath-${customField('xpackVersion')}
tar xvf ~/Downloads/xpack-realpath-9.5.0-1-darwin-x64.tar.gz
chmod -R -w xpack-realpath-9.5.0-1
`} </CodeBlock>

</TabItem>
Expand All @@ -538,9 +538,9 @@ are packed as `.tar.gz` archives.
Download the latest version named like:

<ul>
<li><code>xpack-realpath-{customField('xpackVersion')}-linux-x64.tar.gz</code></li>
<li><code>xpack-realpath-{customField('xpackVersion')}-linux-arm64.tar.gz</code></li>
<li><code>xpack-realpath-{customField('xpackVersion')}-linux-arm.tar.gz</code></li>
<li><code>xpack-realpath-9.5.0-1-linux-x64.tar.gz</code></li>
<li><code>xpack-realpath-9.5.0-1-linux-arm64.tar.gz</code></li>
<li><code>xpack-realpath-9.5.0-1-linux-arm.tar.gz</code></li>
</ul>

:::note
Expand All @@ -555,14 +555,14 @@ unpack the archive and move it to a location of your choice.

The recommended location is
the <code>~/.local/xPacks/realpath</code> folder, for
example <code>/home/ilg/.local/xPacks/realpath/xpack-realpath-{customField('xpackVersion')}</code>:
example <code>/home/ilg/.local/xPacks/realpath/xpack-realpath-9.5.0-1</code>:

<CodeBlock language="console"> {
`mkdir -p ~/.local/xPacks/realpath
cd ~/.local/xPacks/realpath
tar xvf ~/Downloads/xpack-realpath-${customField('xpackVersion')}-linux-x64.tar.gz
chmod -R -w xpack-realpath-${customField('xpackVersion')}
tar xvf ~/Downloads/xpack-realpath-9.5.0-1-linux-x64.tar.gz
chmod -R -w xpack-realpath-9.5.0-1
`} </CodeBlock>

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions website/docs/maintainer/_common/_platform-docker-build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ xpm run docker-build-development --config ${props.platform} -C ~/Work/xpack-dev-
archive and its SHA signature, created in
the <code>build-assets/build/{props.platform}/deploy</code> folder:

- <code>xpack-realpath-{customField('xpackVersion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}</code>
- <code>xpack-realpath-{customField('xpackVersion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}.sha</code>
- <code>xpack-realpath-9.5.0-1-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}</code>
- <code>xpack-realpath-9.5.0-1-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}.sha</code>

To update the build scripts and build the release binaries:

Expand Down
4 changes: 2 additions & 2 deletions website/docs/maintainer/_common/_platform-native-build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ xpm run build-development --config ${props.platform} -C ~/Work/xpack-dev-tools/r
archive and its SHA signature, created in
the <code>build-assets/build/{props.platform}/deploy</code> folder:

- <code>xpack-realpath-{customField('xpackVersion')}-{props.platform}.tar.gz</code>
- <code>xpack-realpath-{customField('xpackVersion')}-{props.platform}.tar.gz.sha</code>
- <code>xpack-realpath-9.5.0-1-{props.platform}.tar.gz</code>
- <code>xpack-realpath-9.5.0-1-{props.platform}.tar.gz.sha</code>

To update the build scripts and build the release binaries:

Expand Down
38 changes: 19 additions & 19 deletions website/docs/maintainer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,10 @@ update the dependencies in `build-assets/package.json`.

### Increase the version and update it in the top `package.json`

- determine the version (like <code>{customField('xpackVersion')}</code>)
- determine the version (like <code>9.5.0-1.1</code>)
- update the version in top `package.json`
- use the new version, suffixed by `.pre`,
like <code>{customField('xpackVersion')}.{customField('npmSubversion')}.pre</code>.
like <code>9.5.0-1.1.pre</code>.

### Update the `websiteConfig` in `website/package.json` (if necessary)

Expand All @@ -191,9 +191,9 @@ the **Increase the version and update VERSION** section.

### Increase the version and update VERSION

Determine the version (like <code>{customField('xpackVersion')}</code>)
Determine the version (like <code>9.5.0-1</code>)
and update the `build-assets/scripts/VERSION` file; the format
is <code>{customField('xpackVersion')}</code>.
is <code>9.5.0-1</code>.
{isXpackSubversionDouble() ?
'The fourth & fifth numbers are the xPack release number of this version. A sixth' :
'The fourth number is the xPack release number of this version. A fifth'} number will be added to the version in `package.json` when the package is published to the `npm` server.
Expand All @@ -212,7 +212,7 @@ Check GitHub issues and pull requests:
- https://github.com/xpack-dev-tools/realpath-xpack/issues
- https://github.com/xpack-dev-tools/realpath-xpack/pulls

and fix them; assign them to a milestone (like <code>{customField('xpackVersion')}</code>).
and fix them; assign them to a milestone (like <code>9.5.0-1</code>).

### Update `CHANGELOG.md`

Expand Down Expand Up @@ -250,8 +250,8 @@ to:
- check if all previous fixed issues are in
- check the latest commits `xpm run git-log`; if necessary, copy/paste lines,
group by dates and edit them using the below regular expressions
- add a new entry like _**\* v{customField('xpackVersion')} prepared**_
- commit with the message _**prepare v{customField('xpackVersion')}**_
- add a new entry like _**\* v9.5.0-1 prepared**_
- commit with the message _**prepare v9.5.0-1**_


### Push the changes to the `xpack-development` branch
Expand Down Expand Up @@ -410,7 +410,7 @@ Copy the trees displayed at the end of the test builds and paste to
- `website/docs/install/_folders-hierarchies-windows.mdx`

If present, replace the actual version
(like **{customField('upstreamVersion')}**) with the following expression:
(like **9.5**) with the following expression:

```txt
${customField('upstreamVersion')}
Expand Down Expand Up @@ -714,7 +714,7 @@ xattr -cr ${HOME}/Downloads/xpack-*
### Create a new GitHub pre-release

- in `CHANGELOG.md`, add the release date and a message
like _**\* v{customField('xpackVersion')} released**_
like _**\* v9.5.0-1 released**_
- commit with the message _**CHANGELOG update**_
- check and possibly update the `build-assets/templates/body-github-release-liquid.mdx`
- push the `xpack-development` branch to GitHub
Expand All @@ -729,8 +729,8 @@ The workflow result and logs are available from the

The result is a
[draft pre-release](https://github.com/xpack-dev-tools/realpath-xpack/releases)
tagged like **v{customField('xpackVersion')}** (mind the dash in the middle!) and
named like **xPack GNU realpath v{customField('xpackVersion')}** (mind the dash),
tagged like **v9.5.0-1** (mind the dash in the middle!) and
named like **xPack GNU realpath v9.5.0-1** (mind the dash),
with all binaries attached.

- edit the draft and be sure it is attached to the `xpack-development` branch (important!)
Expand Down Expand Up @@ -758,7 +758,7 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/realpath-xpack.git/

- edit the front matter properties
- select the correct summary
- commit with the message _**website: blog post release {customField('xpackVersion')} published**_
- commit with the message _**website: blog post release 9.5.0-1 published**_

### Update the web install page

Expand Down Expand Up @@ -790,22 +790,22 @@ xpm run update-package-binaries -C ~/Work/xpack-dev-tools/realpath-xpack.git/bui
- compare the SHA sums with those shown by `cat *.sha`
- check the executable names
- commit all changes with the message
_**package.json: update urls for {customField('xpackVersion')}.{customField('npmSubversion')} release**_
_**package.json: update urls for 9.5.0-1.1 release**_

### Publish on the npmjs.com server

- select the `xpack-development` branch
- check the latest commits `xpm run git-log`
- update `CHANGELOG.md`, add a line like _**\* v{customField('xpackVersion')} published on npmjs.com**_
- commit with the message _**CHANGELOG: publish npm v{customField('xpackVersion')}.{customField('npmSubversion')}**_
- update `CHANGELOG.md`, add a line like _**\* v9.5.0-1.1 published on npmjs.com**_
- commit with the message _**CHANGELOG: publish npm v9.5.0-1.1**_
- `npm pack` and check the content of the archive, which should list
only the `package.json`, the `README.md`, `LICENSE` and `CHANGELOG.md`;
possibly adjust `.npmignore`
- configure the version; the first 4 numbers are the same as the
GitHub release; the fifth number is the npm specific version:

<CodeBlock language="sh"> {
`npm version ${customField('xpackVersion')}.${customField('npmSubversion')}
`npm version 9.5.0-1.1
`} </CodeBlock>

- the commits and the tag should have been pushed by the `postversion` script;
Expand Down Expand Up @@ -845,7 +845,7 @@ The tests results are available from the
When the release is considered stable, promote it as `latest`:

<CodeBlock language="sh"> {
`npm dist-tag add @xpack-dev-tools/realpath@${customField('xpackVersion')}.${customField('npmSubversion')} latest
`npm dist-tag add @xpack-dev-tools/realpath@9.5.0-1.1 latest
`} </CodeBlock>

Check the result:
Expand All @@ -857,7 +857,7 @@ Check the result:
In case the release proves problematic and needs to be unpublished:

<CodeBlock language="sh"> {
`npm unpublish @xpack-dev-tools/realpath@${customField('xpackVersion')}.${customField('npmSubversion')}
`npm unpublish @xpack-dev-tools/realpath@9.5.0-1.1
`} </CodeBlock>

### Build the static website locally
Expand Down Expand Up @@ -947,7 +947,7 @@ Close those that were addressed.

- in a separate browser windows, open [X/Twitter](https://twitter.com)
- using the **`@xpack_project`** account
- paste the release name like _**xPack GNU realpath v{customField('xpackVersion')} released**_
- paste the release name like _**xPack GNU realpath v9.5.0-1 released**_
- paste the link to the blog post
[release](https://github.com/xpack-dev-tools/realpath-xpack/releases)
- click the **Tweet** button
Expand Down
40 changes: 0 additions & 40 deletions website/docs/user/_common/_arm-toolchain-versioning.mdx

This file was deleted.

10 changes: 5 additions & 5 deletions website/docs/user/_common/_versioning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@ import LinksVsForwarders from '@site/src/components/LinksVsForwarders'
The version string used by the
upstream {props.upstreamName ? props.upstreamName : 'GNU realpath'} project
is a three number string
like <code>{customField('releaseSemver')}</code>;
like <code>9.5.0</code>;
to this string the xPack distribution adds a fourth number,
but since [SemVer](https://semver.org) allows only three numbers,
all additional ones can
be added only as pre-release strings, separated by a dash,
like <code>{customField('releaseSemver')}-<b>{customField('xpackSubversion')}</b></code>. When
like <code>9.5.0-<b>1</b></code>. When
published as a npm package, the version gets
a fifth number,
like <code>{customField('xpackVersion')}.<b>{customField('npmSubversion')}</b></code>.
like <code>9.5.0-1.<b>1</b></code>.

Since adherence of third party packages to SemVer is not guaranteed,
it is recommended to avoid referring to the xPack GNU realpath dependency via
a SemVer expressions
like <code>^{customField('xpackVersion')}</code> or <code>~{customField('xpackVersion')}</code>, and
like <code>^9.5.0-1</code> or <code>~9.5.0-1</code>, and
prefer exact matches,
like <code>{customField('xpackVersion')}.{customField('npmSubversion')}</code>.
like <code>9.5.0-1.1</code>.
2 changes: 1 addition & 1 deletion website/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function HomepageHeader() {
<p className="hero__subtitle">{siteConfig.tagline}</p>

<div className={styles.installWithCopy}>
<InstallWithCopy>xpm install @xpack-dev-tools/realpath@{customField('releaseVersion')} --verbose</InstallWithCopy>
<InstallWithCopy>xpm install @xpack-dev-tools/realpath@9.5.0-1.1 --verbose</InstallWithCopy>
</div>

</div>
Expand Down

0 comments on commit 36a43cf

Please sign in to comment.