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 208ca65 commit 936550c
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion website/docs/developer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ To manually fix compliance with the style guide (where possible):
<CodeBlock language="console"> {
`% npm run fix
> xpm@${customField('releaseVersion')} fix
> xpm@0.20.5 fix
> standard --fix test
...
`} </CodeBlock>
Expand Down
10 changes: 5 additions & 5 deletions website/docs/install/_common/_cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ npm install --location=global xpm@latest
To install a **specific version**, specify it explicitly:

<CodeBlock language="sh"> {
`npm install --location=global xpm@${customField('releaseVersion')}
`npm install --location=global xpm@0.20.5
`} </CodeBlock>

<Tabs groupId="operating-systems">
Expand Down Expand Up @@ -167,7 +167,7 @@ already have this path configured and the program should start normally:

<CodeBlock language="console"> {
`C:\>xpm --version
${customField('releaseVersion')}
0.20.5
`} </CodeBlock>

<TroubleshootingWindows />
Expand All @@ -189,7 +189,7 @@ To test if **xpm** starts:

<CodeBlock language="console"> {
`% xpm --version
${customField('releaseVersion')}
0.20.5
`} </CodeBlock>

<Heading as="h3">Show macOS hidden files</Heading>
Expand Down Expand Up @@ -252,7 +252,7 @@ To test if xpm starts:
`$ which xpm
/home/ilg/.nvm/versions/node/${props.nodeVersion}/bin/xpm
$ xpm --version
${customField('releaseVersion')}
0.20.5
`} </CodeBlock>

</TabItem>
Expand All @@ -276,7 +276,7 @@ benefit from it by using the `npx` command, as a trampoline to start **xpm**:

<CodeBlock language="console"> {
`$ npx xpm --version
${customField('releaseVersion')}
0.20.5
`} </CodeBlock>

However, for regular usage, this method is not efficient, since
Expand Down
16 changes: 8 additions & 8 deletions website/docs/maintainer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ kept as a legacy CommonJS dependency.

As required by npm modules, this one also uses [SemVer](https://semver.org).

- determine the next version (like <code>{customField('releaseVersion')}</code>)
- determine the next version (like <code>0.20.5</code>)
- update the version in the top `package.json` file
- use the new version, suffixed by `-pre`, like <code>{customField('releaseVersion')}-pre</code>.
- use the new version, suffixed by `-pre`, like <code>0.20.5-pre</code>.

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

Expand Down Expand Up @@ -132,7 +132,7 @@ Check GitHub Issues and Pull Requests:
- https://github.com/xpack/xpm-js/pulls

and fix them; assign them to a milestone
(like <code>{customField('releaseVersion')}</code>).
(like <code>0.20.5</code>).

### Update `CHANGELOG.md`

Expand Down Expand Up @@ -171,8 +171,8 @@ to:
*
```

- add a new entry like _**\* v{customField('releaseVersion')} prepared**_
- commit with a message like _**prepare v{customField('releaseVersion')}**_
- add a new entry like _**\* v0.20.5 prepared**_
- commit with a message like _**prepare v0.20.5**_

### Prepare the release

Expand All @@ -189,7 +189,7 @@ to:
### Set the new version

<CodeBlock language="sh"> {
`npm version ${customField('releaseVersion')}
`npm version 0.20.5
`} </CodeBlock>

### CI tests
Expand All @@ -210,7 +210,7 @@ npm run generate-website-blog-post

- edit the front matter properties
- select the correct summary
- commit with _**website: blog post release {customField('releaseVersion')} published**_
- commit with _**website: blog post release 0.20.5 published**_
- push the `development` branch

## Publish the release to npmjs.com
Expand Down Expand Up @@ -305,7 +305,7 @@ npm dist-tag ls xpm
When the release is considered stable, promote it as `latest`:

<CodeBlock language="sh"> {
`npm dist-tag add xpm@${customField('releaseVersion')} latest
`npm dist-tag add xpm@0.20.5 latest
npm dist-tag ls xpm
`} </CodeBlock>

Expand Down
2 changes: 1 addition & 1 deletion website/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ function HomepageHeader() {
<p className="hero__subtitle">{siteConfig.tagline}</p>

<div className={styles.installWithCopy}>
<InstallWithCopy>npm install --location=global xpm@{customField('releaseVersion')}</InstallWithCopy>
<InstallWithCopy>npm install --location=global xpm@0.20.5</InstallWithCopy>
</div>

</div>
Expand Down

0 comments on commit 936550c

Please sign in to comment.