Skip to content

Commit 08c2418

Browse files
committed
website: re-generate commons
1 parent f18e0ca commit 08c2418

File tree

11 files changed

+56
-96
lines changed

11 files changed

+56
-96
lines changed

website/docs/developer/_common/_platform-docker-section.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ or, for more verbosity, run the similar development build:
4747
archive and its SHA signature, created in
4848
the <code>build-assets/build/{props.platform}/deploy</code> folder:
4949

50-
- <code>xpack-sed-{customField('xpackVersion')}-{props.platform}.tar.gz</code>
51-
- <code>xpack-sed-{customField('xpackVersion')}-{props.platform}.tar.gz.sha</code>
50+
- <code>xpack-sed-4.9.0-3-{props.platform}.tar.gz</code>
51+
- <code>xpack-sed-4.9.0-3-{props.platform}.tar.gz.sha</code>
5252

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

website/docs/developer/_common/_platform-native-section.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ or, for more verbosity, run the similar development build:
4444
archive and its SHA signature, created in
4545
the <code>build-assets/build/{props.platform}/deploy</code> folder:
4646

47-
- <code>xpack-sed-{customField('xpackVersion')}-{props.platform}.tar.gz</code>
48-
- <code>xpack-sed-{customField('xpackVersion')}-{props.platform}.tar.gz.sha</code>
47+
- <code>xpack-sed-4.9.0-3-{props.platform}.tar.gz</code>
48+
- <code>xpack-sed-4.9.0-3-{props.platform}.tar.gz.sha</code>
4949

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

website/docs/install/_common/_automatic-install-quick-test.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ To check if the {props.longName} installed by **xpm** starts properly, use somet
1818
<TabItem value="macos" label="macOS">
1919

2020
<CodeBlock language="console"> {
21-
`% ~/Library/xPacks/@xpack-dev-tools/${props.shortName}/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version
22-
${props.branding}${customField('upstreamVersion')}
21+
`% ~/Library/xPacks/@xpack-dev-tools/${props.shortName}/4.9.0-3.1/.content/bin/${props.programName} --version
22+
${props.branding}4.9
2323
`} </CodeBlock>
2424

2525
</TabItem>
2626

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

2929
<CodeBlock language="console"> {
30-
`$ ~/.local/xPacks/@xpack-dev-tools/${props.shortName}/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version
31-
${props.branding}${customField('upstreamVersion')}
30+
`$ ~/.local/xPacks/@xpack-dev-tools/${props.shortName}/4.9.0-3.1/.content/bin/${props.programName} --version
31+
${props.branding}4.9
3232
`} </CodeBlock>
3333

3434
</TabItem>

website/docs/install/_common/_manual-install-quick-test.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ To check if the {props.longName} installed manually starts properly, use somethi
1818
<TabItem value="macos" label="macOS">
1919

2020
<CodeBlock language="console"> {
21-
`% ~/Library/xPacks/${props.shortName}/xpack-${props.shortName}-${customField('xpackVersion')}/bin/${props.programName} --version
22-
${props.branding}${customField('upstreamVersion')}
21+
`% ~/Library/xPacks/${props.shortName}/xpack-${props.shortName}-4.9.0-3/bin/${props.programName} --version
22+
${props.branding}4.9
2323
`} </CodeBlock>
2424

2525
</TabItem>
2626

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

2929
<CodeBlock language="console"> {
30-
`$ ~/.local/xPacks/${props.shortName}/xpack-${props.shortName}-${customField('xpackVersion')}/bin/${props.programName} --version
31-
${props.branding}${customField('upstreamVersion')}
30+
`$ ~/.local/xPacks/${props.shortName}/xpack-${props.shortName}-4.9.0-3/bin/${props.programName} --version
31+
${props.branding}4.9
3232
`} </CodeBlock>
3333

3434
</TabItem>

website/docs/install/index.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ The command to install the **latest** available version of **sed** is:
246246
To install a **specific version**, specify it explicitly:
247247

248248
<CodeBlock language="sh"> {
249-
`xpm install @xpack-dev-tools/sed@${customField('releaseVersion')} --verbose
249+
`xpm install @xpack-dev-tools/sed@4.9.0-3.1 --verbose
250250
`} </CodeBlock>
251251

252252
<Tabs groupId="operating-systems">
@@ -349,7 +349,7 @@ The result looks like this:
349349
"dependencies": {},
350350
"devDependencies": {
351351
"@xpack-dev-tools/sed": {
352-
"specifier": "${customField('xpackVersion')}.${customField('npmSubversion')}",
352+
"specifier": "4.9.0-3.1",
353353
"local": "link",
354354
"platforms": "all"
355355
}
@@ -405,15 +405,15 @@ the project build configurations need a PATH adjustment:
405405
<TabItem value="macos" label="macOS">
406406

407407
<CodeBlock language="sh"> {
408-
`export PATH=$HOME/Library/xPacks/\@pack-dev-tools/sed/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin:$PATH
408+
`export PATH=$HOME/Library/xPacks/\@pack-dev-tools/sed/4.9.0-3.1/.content/bin:$PATH
409409
`} </CodeBlock>
410410

411411
</TabItem>
412412

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

415415
<CodeBlock language="sh"> {
416-
`export PATH=$HOME/.local/xPacks/@xpack-dev-tools/sed/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin:$PATH
416+
`export PATH=$HOME/.local/xPacks/@xpack-dev-tools/sed/4.9.0-3.1/.content/bin:$PATH
417417
`} </CodeBlock>
418418

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

505505
<ul>
506-
<li><code>xpack-sed-{customField('xpackVersion')}-darwin-x64.tar.gz</code></li>
507-
<li><code>xpack-sed-{customField('xpackVersion')}-darwin-arm64.tar.gz</code></li>
506+
<li><code>xpack-sed-4.9.0-3-darwin-x64.tar.gz</code></li>
507+
<li><code>xpack-sed-4.9.0-3-darwin-arm64.tar.gz</code></li>
508508
</ul>
509509

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

520520
The recommended location is
521521
the <code>~/Library/xPacks/sed</code> folder, for
522-
example <code>/Users/ilg/Library/xPacks/sed/xpack-sed-{customField('xpackVersion')}</code>:
522+
example <code>/Users/ilg/Library/xPacks/sed/xpack-sed-4.9.0-3</code>:
523523

524524
<CodeBlock language="console"> {
525525
`mkdir -p ~/Library/xPacks/sed
526526
cd ~/Library/xPacks/sed
527527
528-
tar xvf ~/Downloads/xpack-sed-${customField('xpackVersion')}-darwin-x64.tar.gz
529-
chmod -R -w xpack-sed-${customField('xpackVersion')}
528+
tar xvf ~/Downloads/xpack-sed-4.9.0-3-darwin-x64.tar.gz
529+
chmod -R -w xpack-sed-4.9.0-3
530530
`} </CodeBlock>
531531

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

540540
<ul>
541-
<li><code>xpack-sed-{customField('xpackVersion')}-linux-x64.tar.gz</code></li>
542-
<li><code>xpack-sed-{customField('xpackVersion')}-linux-arm64.tar.gz</code></li>
543-
<li><code>xpack-sed-{customField('xpackVersion')}-linux-arm.tar.gz</code></li>
541+
<li><code>xpack-sed-4.9.0-3-linux-x64.tar.gz</code></li>
542+
<li><code>xpack-sed-4.9.0-3-linux-arm64.tar.gz</code></li>
543+
<li><code>xpack-sed-4.9.0-3-linux-arm.tar.gz</code></li>
544544
</ul>
545545

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

556556
The recommended location is
557557
the <code>~/.local/xPacks/sed</code> folder, for
558-
example <code>/home/ilg/.local/xPacks/sed/xpack-sed-{customField('xpackVersion')}</code>:
558+
example <code>/home/ilg/.local/xPacks/sed/xpack-sed-4.9.0-3</code>:
559559

560560
<CodeBlock language="console"> {
561561
`mkdir -p ~/.local/xPacks/sed
562562
cd ~/.local/xPacks/sed
563563
564-
tar xvf ~/Downloads/xpack-sed-${customField('xpackVersion')}-linux-x64.tar.gz
565-
chmod -R -w xpack-sed-${customField('xpackVersion')}
564+
tar xvf ~/Downloads/xpack-sed-4.9.0-3-linux-x64.tar.gz
565+
chmod -R -w xpack-sed-4.9.0-3
566566
`} </CodeBlock>
567567

568568
</TabItem>

website/docs/maintainer/_common/_platform-docker-build.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ xpm run docker-build-development --config ${props.platform} -C ~/Work/xpack-dev-
4141
archive and its SHA signature, created in
4242
the <code>build-assets/build/{props.platform}/deploy</code> folder:
4343

44-
- <code>xpack-sed-{customField('xpackVersion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}</code>
45-
- <code>xpack-sed-{customField('xpackVersion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}.sha</code>
44+
- <code>xpack-sed-4.9.0-3-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}</code>
45+
- <code>xpack-sed-4.9.0-3-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}.sha</code>
4646

4747
To update the build scripts and build the release binaries:
4848

website/docs/maintainer/_common/_platform-native-build.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ xpm run build-development --config ${props.platform} -C ~/Work/xpack-dev-tools/s
4040
archive and its SHA signature, created in
4141
the <code>build-assets/build/{props.platform}/deploy</code> folder:
4242

43-
- <code>xpack-sed-{customField('xpackVersion')}-{props.platform}.tar.gz</code>
44-
- <code>xpack-sed-{customField('xpackVersion')}-{props.platform}.tar.gz.sha</code>
43+
- <code>xpack-sed-4.9.0-3-{props.platform}.tar.gz</code>
44+
- <code>xpack-sed-4.9.0-3-{props.platform}.tar.gz.sha</code>
4545

4646
To update the build scripts and build the release binaries:
4747

website/docs/maintainer/index.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -164,10 +164,10 @@ update the dependencies in `build-assets/package.json`.
164164

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

167-
- determine the version (like <code>{customField('xpackVersion')}</code>)
167+
- determine the version (like <code>4.9.0-3.1</code>)
168168
- update the version in top `package.json`
169169
- use the new version, suffixed by `.pre`,
170-
like <code>{customField('xpackVersion')}.{customField('npmSubversion')}.pre</code>.
170+
like <code>4.9.0-3.1.pre</code>.
171171

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

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

192192
### Increase the version and update VERSION
193193

194-
Determine the version (like <code>{customField('xpackVersion')}</code>)
194+
Determine the version (like <code>4.9.0-3</code>)
195195
and update the `build-assets/scripts/VERSION` file; the format
196-
is <code>{customField('xpackVersion')}</code>.
196+
is <code>4.9.0-3</code>.
197197
{isXpackSubversionDouble() ?
198198
'The fourth & fifth numbers are the xPack release number of this version. A sixth' :
199199
'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.
@@ -212,7 +212,7 @@ Check GitHub issues and pull requests:
212212
- https://github.com/xpack-dev-tools/sed-xpack/issues
213213
- https://github.com/xpack-dev-tools/sed-xpack/pulls
214214

215-
and fix them; assign them to a milestone (like <code>{customField('xpackVersion')}</code>).
215+
and fix them; assign them to a milestone (like <code>4.9.0-3</code>).
216216

217217
### Update `CHANGELOG.md`
218218

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

256256

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

412412
If present, replace the actual version
413-
(like **{customField('upstreamVersion')}**) with the following expression:
413+
(like **4.9**) with the following expression:
414414

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

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

730730
The result is a
731731
[draft pre-release](https://github.com/xpack-dev-tools/sed-xpack/releases)
732-
tagged like **v{customField('xpackVersion')}** (mind the dash in the middle!) and
733-
named like **xPack GNU sed v{customField('xpackVersion')}** (mind the dash),
732+
tagged like **v4.9.0-3** (mind the dash in the middle!) and
733+
named like **xPack GNU sed v4.9.0-3** (mind the dash),
734734
with all binaries attached.
735735

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

759759
- edit the front matter properties
760760
- select the correct summary
761-
- commit with the message _**website: blog post release {customField('xpackVersion')} published**_
761+
- commit with the message _**website: blog post release 4.9.0-3 published**_
762762

763763
### Update the web install page
764764

@@ -790,22 +790,22 @@ xpm run update-package-binaries -C ~/Work/xpack-dev-tools/sed-xpack.git/build-as
790790
- compare the SHA sums with those shown by `cat *.sha`
791791
- check the executable names
792792
- commit all changes with the message
793-
_**package.json: update urls for {customField('xpackVersion')}.{customField('npmSubversion')} release**_
793+
_**package.json: update urls for 4.9.0-3.1 release**_
794794

795795
### Publish on the npmjs.com server
796796

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

807807
<CodeBlock language="sh"> {
808-
`npm version ${customField('xpackVersion')}.${customField('npmSubversion')}
808+
`npm version 4.9.0-3.1
809809
`} </CodeBlock>
810810

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

847847
<CodeBlock language="sh"> {
848-
`npm dist-tag add @xpack-dev-tools/sed@${customField('xpackVersion')}.${customField('npmSubversion')} latest
848+
`npm dist-tag add @xpack-dev-tools/sed@4.9.0-3.1 latest
849849
`} </CodeBlock>
850850

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

859859
<CodeBlock language="sh"> {
860-
`npm unpublish @xpack-dev-tools/sed@${customField('xpackVersion')}.${customField('npmSubversion')}
860+
`npm unpublish @xpack-dev-tools/sed@4.9.0-3.1
861861
`} </CodeBlock>
862862

863863
### Build the static website locally
@@ -947,7 +947,7 @@ Close those that were addressed.
947947

948948
- in a separate browser windows, open [X/Twitter](https://twitter.com)
949949
- using the **`@xpack_project`** account
950-
- paste the release name like _**xPack GNU sed v{customField('xpackVersion')} released**_
950+
- paste the release name like _**xPack GNU sed v4.9.0-3 released**_
951951
- paste the link to the blog post
952952
[release](https://github.com/xpack-dev-tools/sed-xpack/releases)
953953
- click the **Tweet** button

website/docs/user/_common/_arm-toolchain-versioning.mdx

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

website/docs/user/_common/_versioning.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ import LinksVsForwarders from '@site/src/components/LinksVsForwarders'
1515
The version string used by the
1616
upstream {props.upstreamName ? props.upstreamName : 'GNU sed'} project
1717
is a three number string
18-
like <code>{customField('releaseSemver')}</code>;
18+
like <code>4.9.0</code>;
1919
to this string the xPack distribution adds a fourth number,
2020
but since [SemVer](https://semver.org) allows only three numbers,
2121
all additional ones can
2222
be added only as pre-release strings, separated by a dash,
23-
like <code>{customField('releaseSemver')}-<b>{customField('xpackSubversion')}</b></code>. When
23+
like <code>4.9.0-<b>3</b></code>. When
2424
published as a npm package, the version gets
2525
a fifth number,
26-
like <code>{customField('xpackVersion')}.<b>{customField('npmSubversion')}</b></code>.
26+
like <code>4.9.0-3.<b>1</b></code>.
2727

2828
Since adherence of third party packages to SemVer is not guaranteed,
2929
it is recommended to avoid referring to the xPack GNU sed dependency via
3030
a SemVer expressions
31-
like <code>^{customField('xpackVersion')}</code> or <code>~{customField('xpackVersion')}</code>, and
31+
like <code>^4.9.0-3</code> or <code>~4.9.0-3</code>, and
3232
prefer exact matches,
33-
like <code>{customField('xpackVersion')}.{customField('npmSubversion')}</code>.
33+
like <code>4.9.0-3.1</code>.

0 commit comments

Comments
 (0)