Skip to content

Commit

Permalink
website: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Jan 2, 2025
1 parent 26aad96 commit 9039e72
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 23 deletions.
2 changes: 1 addition & 1 deletion website/docs/developer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ invoked via a single mouse click, for example:
## Prerequisites

The build scripts run on GNU/Linux and macOS. The Windows binaries are
compiled on x64 GNU/Linux, using [mingw-w64](https://mingw-w64.org).
compiled on GNU/Linux, using [mingw-w64](https://mingw-w64.org).

For details on installing the prerequisites, please read the
[Build Prerequisites](https://xpack-dev-tools.github.io/docs/developer/install/prerequisites/)
Expand Down
23 changes: 12 additions & 11 deletions website/docs/maintainer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -220,13 +220,6 @@ and fix them; assign them to a milestone (like <code>{customField('xpackVersion'

### Update `CHANGELOG.md`

- open the `CHANGELOG.md` file
- 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')}**_

To turn the dates into headings, change from:

```txt
Expand Down Expand Up @@ -257,6 +250,14 @@ to:
*
```

- open the `CHANGELOG.md` file
- 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')}**_


### Push the changes to the `xpack-development` branch

Be sure that the latest commit that updates `VERSION` is pushed
Expand Down Expand Up @@ -619,7 +620,7 @@ xpm run trigger-workflow-build-linux-arm64 -C ~/Work/xpack-dev-tools/clang-xpack
xpm run trigger-workflow-build-linux-arm -C ~/Work/xpack-dev-tools/clang-xpack.git/build-assets
```

The scripts behind these actions require the `XPACK_DEV_TOOLS_FG_DISPATCH_TOKEN`
The scripts behind these actions require the `GITHUB_API_DISPATCH_TOKEN`
variable to be present
in the environment, and the organization `PUBLISH_TOKEN` to be visible in the
SettingsAction
Expand Down Expand Up @@ -663,7 +664,7 @@ xpm run trigger-workflow-test-docker-linux-x64 -C ~/Work/xpack-dev-tools/clang-x
xpm run trigger-workflow-test-docker-linux-arm -C ~/Work/xpack-dev-tools/clang-xpack.git/build-assets
```

The scripts behind these accessible require the `XPACK_DEV_TOOLS_FG_DISPATCH_TOKEN` variable to be present
The scripts behind these accessible require the `GITHUB_API_DISPATCH_TOKEN` variable to be present
in the environment.

These actions use the `xpack-development` branch of this repo and the
Expand Down Expand Up @@ -784,7 +785,7 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/clang-xpack.git/bui

### Check the list of links in top package.json

- open the `package.json` file
- open the top `package.json` file
- check if the links in the `bin` property cover the actual binaries
- if necessary, also check on Windows

Expand Down Expand Up @@ -907,7 +908,7 @@ and the X/Twitter announcement
- switch to https://xpack-dev-tools.github.io/clang-xpack/docs/maintainer/#update-the-xpack-branch

The `website` branch may be subsequently updated, as long as the
version in `package.json` is not changed.
version in the top `package.json` is not changed.

### Update the `xpack` branch

Expand Down
32 changes: 21 additions & 11 deletions website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -335,19 +335,29 @@ const config: Config = {
'aria-label': 'GitHub repository',
},
{
label: `v${customFields.xpackVersion}`,
position: 'right',
href: `https://github.com/xpack-dev-tools/clang-xpack/releases/tag/v${customFields.xpackVersion}`,
},
{
href: 'https://github.com/xpack-dev-tools/',
label: 'xpack-dev-tools',
type: 'dropdown',
href: 'https://github.com/xpack-dev-tools/clang-xpack/',
position: 'right',
label: 'GitHub',
items: [
{
label: `clang-xpack`,
href: `https://github.com/xpack-dev-tools/clang-xpack/`,
},
{
label: 'xpack-dev-tools org',
href: 'https://github.com/xpack-dev-tools/',
},
{
label: 'xpack org',
href: 'https://github.com/xpack/',
},
]
},
{
href: 'https://github.com/xpack/',
label: 'xpack',
label: `${customFields.xpackVersion}`,
position: 'right',
href: `https://github.com/xpack-dev-tools/clang-xpack/releases/tag/v${customFields.xpackVersion}`,
},
],
},
Expand Down Expand Up @@ -408,11 +418,11 @@ const config: Config = {
href: 'https://github.com/xpack-dev-tools/clang-xpack/',
},
{
label: 'GitHub xpack-dev-tools',
label: 'GitHub xpack-dev-tools org',
href: 'https://github.com/xpack-dev-tools/',
},
{
label: 'GitHub xpack',
label: 'GitHub xpack org',
href: 'https://github.com/xpack/',
},
],
Expand Down

0 comments on commit 9039e72

Please sign in to comment.