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 20, 2025
1 parent c9c1802 commit acb387d
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 48 deletions.
6 changes: 3 additions & 3 deletions website/blog/_common/_download-analytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import Image from '@theme/IdealImage';

- GitHub [xpack-dev-tools/riscv-none-elf-gcc-xpack](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/)
- this release <a href={`https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/v${props.version}/`} ><Image img={`https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/v${props.version}/total.svg`} alt='Github Release' /></a>
- all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/total.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/)
- deprecated xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-embed-gcc-xpack/total.svg)](https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases/)
- all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/riscv-none-gcc/total.svg)](https://github.com/gnu-mcu-eclipse/riscv-none-gcc/releases/)
- all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/total.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases)
- deprecated xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-embed-gcc-xpack/total.svg)](https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases)
- all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/riscv-none-gcc/total.svg)](https://github.com/gnu-mcu-eclipse/riscv-none-gcc/releases)
- [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=riscv-none-elf-gcc-xpack) (grouped by release)
- npmjs.com [@xpack-dev-tools/riscv-none-elf-gcc](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc)
- latest releases [![npm](https://img.shields.io/npm/dw/@xpack-dev-tools/riscv-none-elf-gcc.svg)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/)
Expand Down
8 changes: 4 additions & 4 deletions website/blog/_templates/blog-post-release-part-1-liquid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ tags:
# ----- Custom properties -----------------------------------------------------

gcc_version: "{{upstreamVersion}}"
binutils_version: "{{customFields.binutilsVersionMajor}}.{{customFields.binutilsVersionMinor}}"
gdb_version: "{{customFields.gdbVersionMajor}}.{{customFields.gdbVersionMinor}}"
newlib_version: "{{customFields.newlibVersion}}"
python_version: "{{customFields.pythonVersion}}"
binutils_version: "{{packageWebsiteConfig.binutilsVersionMajor}}.{{packageWebsiteConfig.binutilsVersionMinor}}"
gdb_version: "{{packageWebsiteConfig.gdbVersionMajor}}.{{packageWebsiteConfig.gdbVersionMinor}}"
newlib_version: "{{packageWebsiteConfig.newlibVersion}}"
python_version: "{{packageWebsiteConfig.pythonVersion}}"

version: "{{releaseVersion}}"
npm_subversion: "1"
Expand Down
2 changes: 1 addition & 1 deletion website/docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ presented in the
## Support & feedback

The quick advice for getting support and providing feedback is to use the
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions/).
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions).

For additional information, please refer to the
[Help Centre](/docs/support/) page.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ import Testing from './_testing.mdx';
# How to install the xPack GNU RISC-V Embedded GCC

[![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack-dev-tools/riscv-none-elf-gcc-xpack)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/blob/xpack/package.json)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/xpack-dev-tools/riscv-none-elf-gcc-xpack)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/)
[![GitHub Release Date](https://img.shields.io/github/release-date/xpack-dev-tools/riscv-none-elf-gcc-xpack)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/xpack-dev-tools/riscv-none-elf-gcc-xpack)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/xpack-dev-tools/riscv-none-elf-gcc-xpack)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases)
[![npm (scoped)](https://img.shields.io/npm/v/%40xpack-dev-tools%2Friscv-none-elf-gcc?label=xpm&color=blue)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/total)
[![npm](https://img.shields.io/npm/dm/%40xpack-dev-tools%2Friscv-none-elf-gcc?label=xpm%20downloads)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/)
Expand Down Expand Up @@ -543,7 +543,7 @@ For all platforms, the **xPack GNU RISC-V Embedded GCC** binaries are released a
archives that can be installed in any location.

The archives can be downloaded from
the <a href={`https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/`}>GitHub Releases</a> pages.
the <a href={`https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases`}>GitHub Releases</a> pages.

### Download & unpack {#manual-install-download-and-unpack}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
The current release must be announced in the
[GCC Timeline](https://gcc.gnu.org/releases.html) page.
Compare the latest GCC release with the current xPack
[release](https://github.com/xpack-dev-tools/gcc-xpack/releases/).
[release](https://github.com/xpack-dev-tools/gcc-xpack/releases).

If necessary, update the triplet, otherwise increase the fourth number,
as below.
Expand Down
22 changes: 11 additions & 11 deletions website/docs/maintainer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ import PlatformDockerBuild from './_common/_platform-docker-build.mdx'
# How to make new xPack GNU RISC-V Embedded GCC releases

[![license](https://img.shields.io/github/license/xpack-dev-tools/riscv-none-elf-gcc-xpack)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/blob/xpack/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/xpack-dev-tools/riscv-none-elf-gcc-xpack.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/issues/)
[![GitHub issues](https://img.shields.io/github/issues/xpack-dev-tools/riscv-none-elf-gcc-xpack.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/issues)
[![GitHub pulls](https://img.shields.io/github/issues-pr/xpack-dev-tools/riscv-none-elf-gcc-xpack.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/pulls)

This page is designed for maintainers of the
Expand Down Expand Up @@ -631,7 +631,7 @@ These commands use the `xpack-development` branch of this repo.
<GitHubActionsDurations/>

The workflow results and logs are available from the
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions/) page.
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions) page.

Update the values in `website/docs/maintainer/_github-actions-durations.mdx`
with those shown by GitHub Actions.
Expand Down Expand Up @@ -676,7 +676,7 @@ Some of the `docker-linux-arm` tests have an issue on Debian and the
:::

The tests results are available from the
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions/) page.
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions) page.

After running the prime tests, download the test results and compare
with previous runs.
Expand Down Expand Up @@ -738,10 +738,10 @@ xpm run trigger-workflow-publish-release -C ~/Work/xpack-dev-tools/riscv-none-el
```

The workflow result and logs are available from the
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions/) page.
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions) page.

The result is a
[draft pre-release](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/)
[draft pre-release](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases)
tagged like **v{customField('xpackVersion')}** (mind the dash in the middle!) and
named like **xPack GNU RISC-V Embedded GCC v{customField('xpackVersion')}** (mind the dash),
with all binaries attached.
Expand Down Expand Up @@ -849,7 +849,7 @@ xpm run trigger-workflow-test-xpm -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-x
This will install the package via `xpm install` on all supported platforms.

The tests results are available from the
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions/) page.
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions) page.



Expand Down Expand Up @@ -915,7 +915,7 @@ Avoid further updates to the `xpack` branch until the next release.

### Create the final GitHub release

- go to the [GitHub Releases](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/) page
- go to the [GitHub Releases](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases) page
- check the download counter, it should match the number of tests
- add a link to the Web blog `[Continue reading »]()`; use an same blog URL
- remove the _tests only_ notice
Expand Down Expand Up @@ -945,7 +945,7 @@ xpm run trigger-workflow-deep-clean -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc
This will remove the build folders on all self-hosted runners.

The results are available from the
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions/) page.
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions) page.

### Close possible open issues

Expand All @@ -962,7 +962,7 @@ Close those that were addressed.
- using the **`@xpack_project`** account
- paste the release name like _**xPack GNU RISC-V Embedded GCC v{customField('xpackVersion')} released**_
- paste the link to the blog post
[release](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/)
[release](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases)
- click the **Tweet** button

<ShareCustom/>
Expand All @@ -971,8 +971,8 @@ Close those that were addressed.

- GitHub [`xpack-dev-tools/riscv-none-elf-gcc-xpack`](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/) repo
- latest xPack release
[![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/latest/total.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/)
- all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/total.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/)
[![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/latest/total.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases)
- all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/total.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases)
- [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=riscv-none-elf-gcc-xpack) (grouped by release)
- npmjs.com [`@xpack-dev-tools/riscv-none-elf-gcc`](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/) xPack
- latest release, per month
Expand Down
14 changes: 7 additions & 7 deletions website/docs/support/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import Documentation from '../getting-started/_documentation.mdx';
## Quick links

The quick answer is to use the
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions/) pages.
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions) pages.

## Check documentation

Expand All @@ -41,18 +41,18 @@ check if the subject was not already addressed.

- check the [FAQ](/docs/faq/)
for similar problems
- check the [GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions/) for
- check the [GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions) for
similar topics
- check the
[GitHub Issues](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/issues/)
[GitHub Issues](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/issues)
tracker for similar problems.

## Ask questions in GitHub Discussions

If you still could not find a solution, if you have interesting use
cases, if you have custom configurations, and generally if you have
any experience that you want to share with others, use the
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions/) pages,
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions) pages,
and enter a **New discussion**; use the **Q&A** category for questions, **Ideas** for suggestions and **General** for anything else.

## Register a new support ticket only if necessary
Expand All @@ -62,14 +62,14 @@ distribution, not to the upstream GNU RISC-V Embedded GCC itself
(if you have doubts, use the GitHub Discussions),
or if you have a pertinent suggestion how to enhance the **xPack GNU RISC-V Embedded GCC**
distribution, register a **New Issue** in the
[GitHub Issues](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/issues/)
[GitHub Issues](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/issues)
tracker.

:::tip

**Do not** use the GitHub Issues tracker
for questions and support, **use the
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions/)** pages.
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions)** pages.

:::

Expand All @@ -79,7 +79,7 @@ for questions and support, **use the

**Do not** use
private e-mail for support, **use the
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions/)** pages.
[GitHub Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions)** pages.

:::

Expand Down
8 changes: 1 addition & 7 deletions website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,7 @@ function getCustomFields() {

const customFields = websitePackageJson?.websiteConfig?.customFields ?? {};

let upstreamVersion
if (customFields.hasTwoNumbersVersion === 'true' && xpackSemver.endsWith('.0')) {
// Remove the patch number if zero (wine uses both 2 and 3 numbers).
upstreamVersion = xpackSemver.replace(/[.]0*$/, '');
} else {
upstreamVersion = xpackSemver;
}
let upstreamVersion = xpackSemver;

return {
version: jsonVersion,
Expand Down
20 changes: 9 additions & 11 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,15 @@
]
},
"websiteConfig": {
"customFields": {
"programName": "riscv-none-elf-gcc",
"branding": "riscv-none-elf-gcc (xPack GNU RISC-V Embedded GCC x86_64) ",
"showDeprecatedRiscvGccAnalytics": "true",
"gdbVersionMajor": "15",
"gdbVersionMinor": "1",
"binutilsVersionMajor": "2",
"binutilsVersionMinor": "43.1",
"pythonVersion": "3.12.2",
"newlibVersion": "4.4.0"
}
"programName": "riscv-none-elf-gcc",
"branding": "riscv-none-elf-gcc (xPack GNU RISC-V Embedded GCC x86_64) ",
"showDeprecatedRiscvGccAnalytics": "true",
"gdbVersionMajor": "15",
"gdbVersionMinor": "1",
"binutilsVersionMajor": "2",
"binutilsVersionMinor": "43.1",
"pythonVersion": "3.12.2",
"newlibVersion": "4.4.0"
},
"engines": {
"node": ">=18.0"
Expand Down

0 comments on commit acb387d

Please sign in to comment.