Skip to content

Commit

Permalink
prepare v13.3.0-1
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Jul 24, 2024
1 parent 24b551b commit e2fcf63
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 45 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Entries in this file are in reverse chronological order.

## 2024-07-24

* v14.1.0-1.1 published on npmjs.com
* v13.3.0-1 prepared
* 24b551b 14.1.0-1.1
* 307f6dd CHANGELOG update
* c563c48 package.json: update urls for 14.1.0-1 release
* 68460a0 templates/jekyll update
* e0af91b CHANGELOG update
Expand Down
68 changes: 34 additions & 34 deletions README-MAINTAINER.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ update the dependencies in `package.json`.

### Identify the main GCC version

Determine the GCC version (like `14.1.0`) and update the `scripts/VERSION`
file; the format is `14.1.0-1`. The fourth digit is the number of the
Determine the GCC version (like `13.3.0`) and update the `scripts/VERSION`
file; the format is `13.3.0-1`. The fourth digit is the number of the
the xPack GNU RISC-V Embedded GCC release number of this version.

### Fix possible open issues
Expand All @@ -111,7 +111,7 @@ Check GitHub issues and pull requests:

- <https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/issues/>

and fix them; assign them to a milestone (like `14.1.0-1`).
and fix them; assign them to a milestone (like `13.3.0-1`).

### Check `README.md`

Expand All @@ -121,22 +121,22 @@ but in the version specific release page.

### Update versions in `README` files

Update both full 5 numbers (`14.1.0-1.1`) and short 3 numbers (`14.1.0`)
Update both full 5 numbers (`13.3.0-1.1`) and short 3 numbers (`13.3.0`)
versions in:

- update version in `README-MAINTAINER.md`
- update version in `README.md`

### Update version in `package.json` to a pre-release

Use the new version, suffixed by `pre`, like `14.1.0-1.pre`.
Use the new version, suffixed by `pre`, like `13.3.0-1.pre`.

### Update `CHANGELOG.md`

- open the `CHANGELOG.md` file
- check if all previous fixed issues are in
- add a new entry like _* v14.1.0-1 prepared_
- commit with a message like _prepare v14.1.0-1_
- add a new entry like _* v13.3.0-1 prepared_
- commit with a message like _prepare v13.3.0-1_

### Update the version specific code

Expand Down Expand Up @@ -231,8 +231,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build/darwin-x64/deploy
total 262456
-rw-r--r-- 1 ilg staff 131934771 Aug 23 01:57 xpack-riscv-none-elf-gcc-14.1.0-1-darwin-x64.tar.gz
-rw-r--r-- 1 ilg staff 118 Aug 23 01:57 xpack-riscv-none-elf-gcc-14.1.0-1-darwin-x64.tar.gz.sha
-rw-r--r-- 1 ilg staff 131934771 Aug 23 01:57 xpack-riscv-none-elf-gcc-13.3.0-1-darwin-x64.tar.gz
-rw-r--r-- 1 ilg staff 118 Aug 23 01:57 xpack-riscv-none-elf-gcc-13.3.0-1-darwin-x64.tar.gz.sha
```

#### Apple Silicon macOS
Expand Down Expand Up @@ -266,8 +266,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build/darwin-arm64/deploy
total 263048
-rw-r--r-- 1 ilg staff 128160032 Aug 23 01:22 xpack-riscv-none-elf-gcc-14.1.0-1-darwin-arm64.tar.gz
-rw-r--r-- 1 ilg staff 120 Aug 23 01:22 xpack-riscv-none-elf-gcc-14.1.0-1-darwin-arm64.tar.gz.sha
-rw-r--r-- 1 ilg staff 128160032 Aug 23 01:22 xpack-riscv-none-elf-gcc-13.3.0-1-darwin-arm64.tar.gz
-rw-r--r-- 1 ilg staff 120 Aug 23 01:22 xpack-riscv-none-elf-gcc-13.3.0-1-darwin-arm64.tar.gz.sha
```

#### Intel GNU/Linux
Expand Down Expand Up @@ -303,8 +303,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build/linux-x64/deploy
total 138680
-rw-r--r-- 1 ilg ilg 142003499 Aug 22 23:14 xpack-riscv-none-elf-gcc-14.1.0-1-linux-x64.tar.gz
-rw-r--r-- 1 ilg ilg 117 Aug 22 23:14 xpack-riscv-none-elf-gcc-14.1.0-1-linux-x64.tar.gz.sha
-rw-r--r-- 1 ilg ilg 142003499 Aug 22 23:14 xpack-riscv-none-elf-gcc-13.3.0-1-linux-x64.tar.gz
-rw-r--r-- 1 ilg ilg 117 Aug 22 23:14 xpack-riscv-none-elf-gcc-13.3.0-1-linux-x64.tar.gz.sha
```

##### Build the Intel Windows binaries
Expand All @@ -331,8 +331,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build/win32-x64/deploy
total 150400
-rw-r--r-- 1 ilg ilg 153999860 Aug 22 23:06 xpack-riscv-none-elf-gcc-14.1.0-1-win32-x64.zip
-rw-r--r-- 1 ilg ilg 114 Aug 22 23:06 xpack-riscv-none-elf-gcc-14.1.0-1-win32-x64.zip.sha
-rw-r--r-- 1 ilg ilg 153999860 Aug 22 23:06 xpack-riscv-none-elf-gcc-13.3.0-1-win32-x64.zip
-rw-r--r-- 1 ilg ilg 114 Aug 22 23:06 xpack-riscv-none-elf-gcc-13.3.0-1-win32-x64.zip.sha
```

#### Arm GNU/Linux 64-bit
Expand Down Expand Up @@ -366,8 +366,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build/linux-arm64/deploy
total 135604
-rw-r--r-- 1 ilg ilg 138853247 Aug 22 19:26 xpack-riscv-none-elf-gcc-14.1.0-1-linux-arm64.tar.gz
-rw-r--r-- 1 ilg ilg 119 Aug 22 19:26 xpack-riscv-none-elf-gcc-14.1.0-1-linux-arm64.tar.gz.sha
-rw-r--r-- 1 ilg ilg 138853247 Aug 22 19:26 xpack-riscv-none-elf-gcc-13.3.0-1-linux-arm64.tar.gz
-rw-r--r-- 1 ilg ilg 119 Aug 22 19:26 xpack-riscv-none-elf-gcc-13.3.0-1-linux-arm64.tar.gz.sha
```

#### Arm GNU/Linux 32-bit
Expand Down Expand Up @@ -401,8 +401,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build/linux-arm/deploy
total 129736
-rw-r--r-- 1 ilg ilg 132843190 Aug 22 19:15 xpack-riscv-none-elf-gcc-14.1.0-1-linux-arm.tar.gz
-rw-r--r-- 1 ilg ilg 117 Aug 22 19:15 xpack-riscv-none-elf-gcc-14.1.0-1-linux-arm.tar.gz.sha
-rw-r--r-- 1 ilg ilg 132843190 Aug 22 19:15 xpack-riscv-none-elf-gcc-13.3.0-1-linux-arm.tar.gz
-rw-r--r-- 1 ilg ilg 117 Aug 22 19:15 xpack-riscv-none-elf-gcc-13.3.0-1-linux-arm.tar.gz.sha
```

### Update README-MAINTAINER listing output
Expand Down Expand Up @@ -660,8 +660,8 @@ git clone \
- check version:

```sh
.../riscv-none-elf-gcc-14.1.0-1.1/bin/riscv-none-elf-gcc --version
riscv-none-elf-gcc (xPack GNU RISC-V Embedded GCC x86_64) 14.1.0
.../riscv-none-elf-gcc-13.3.0-1.1/bin/riscv-none-elf-gcc --version
riscv-none-elf-gcc (xPack GNU RISC-V Embedded GCC x86_64) 13.3.0
```

- in a separate workspace, Import → General → Existing Projects into Workspace
Expand All @@ -688,7 +688,7 @@ riscv-none-elf-gcc (xPack GNU RISC-V Embedded GCC x86_64) 14.1.0

## Create a new GitHub pre-release draft

- in `CHANGELOG.md`, add the release date and a message like _* v14.1.0-1 released_
- in `CHANGELOG.md`, add the release date and a message like _* v13.3.0-1 released_
- commit with _CHANGELOG update_
- check and possibly update the `templates/body-github-release-liquid.md`
- push the `xpack-develop` branch
Expand All @@ -699,8 +699,8 @@ The workflows results and logs are available from the

The result is a
[draft pre-release](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/)
tagged like **v14.1.0-1** (mind the dash in the middle!) and
named like **xPack GNU RISC-V Embedded GCC v14.1.0-1** (mind the dash),
tagged like **v13.3.0-1** (mind the dash in the middle!) and
named like **xPack GNU RISC-V Embedded GCC v13.3.0-1** (mind the dash),
with all binaries attached.

- edit the draft and attach it to the `xpack-develop` branch (important!)
Expand All @@ -723,7 +723,7 @@ If any, refer to closed
## Update the preview Web

- commit the `develop` branch of `xpack/web-jekyll` GitHub repo;
use a message like _xPack GNU RISC-V Embedded GCC v14.1.0-1 released_
use a message like _xPack GNU RISC-V Embedded GCC v13.3.0-1 released_
- push to GitHub
- wait for the GitHub Pages build to complete
- the preview web is <https://xpack.github.io/web-preview/news/>
Expand Down Expand Up @@ -764,18 +764,18 @@ watching this project.
- compare the SHA sums with those shown by `cat *.sha`
- check the executable names
- commit all changes, use a message like
_package.json: update urls for 14.1.0-1 release_ (without _v_)
_package.json: update urls for 13.3.0-1 release_ (without _v_)

## Publish on the npmjs.com server

- select the `xpack-develop` branch
- check the latest commits `npm run git-log`
- update `CHANGELOG.md`, add a line like _* v14.1.0-1.1 published on npmjs.com_
- commit with a message like _CHANGELOG: publish npm v14.1.0-1.1_
- update `CHANGELOG.md`, add a line like _* v13.3.0-1.1 published on npmjs.com_
- commit with a message like _CHANGELOG: publish npm v13.3.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`
- `npm version 14.1.0-1.1`; the first 4 numbers are the same as the
- `npm version 13.3.0-1.1`; the first 4 numbers are the same as the
GitHub release; the fifth number is the npm specific version
- the commits and the tag should have been pushed by the `postversion` script;
if not, push them with `git push origin --tags`
Expand Down Expand Up @@ -804,12 +804,12 @@ The tests results are available from the
When the release is considered stable, promote it as `latest`:

- `npm dist-tag ls @xpack-dev-tools/riscv-none-elf-gcc`
- `npm dist-tag add @xpack-dev-tools/riscv-none-elf-gcc@14.1.0-1.1 latest`
- `npm dist-tag add @xpack-dev-tools/riscv-none-elf-gcc@13.3.0-1.1 latest`
- `npm dist-tag ls @xpack-dev-tools/riscv-none-elf-gcc`

In case the previous version is not functional and needs to be unpublished:

- `npm unpublish @xpack-dev-tools/riscv-none-elf-gcc@14.1.0-1.1`
- `npm unpublish @xpack-dev-tools/riscv-none-elf-gcc@13.3.0-1.1`

## Update the Web

Expand All @@ -831,7 +831,7 @@ In case the previous version is not functional and needs to be unpublished:

- in a separate browser windows, open [X/Twitter](https://twitter.com)
- using the `@xpack_project` account
- paste the release name like **xPack GNU RISC-V Embedded GCC v14.1.0-1 released**
- paste the release name like **xPack GNU RISC-V Embedded GCC v13.3.0-1 released**
- paste the link to the Web page
[release](https://xpack.github.io/riscv-none-elf-gcc/releases/)
- click the **Tweet** button
Expand Down Expand Up @@ -859,9 +859,9 @@ Add a new topic in the **Announcements** category of the
[RISC-V forums]<https://groups.google.com/a/groups.riscv.org/g/sw-dev>).

```console
Subject: xPack GNU RISC-V Embedded GCC v14.1.0-1 released
Subject: xPack GNU RISC-V Embedded GCC v13.3.0-1 released

Version 14.1.0-1 is a new release of the xPack GNU RISC-V Embedded GCC; it follows the GNU GCC release.
Version 13.3.0-1 is a new release of the xPack GNU RISC-V Embedded GCC; it follows the GNU GCC release.

https://xpack.github.io/blog/2022/05/14/riscv-none-elf-gcc-v11-3-0-1-released/
```
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ After install, the package should create a structure like this (only the
first two depth levels are shown):

```console
$ tree -L 2 /Users/ilg/Library/xPacks/\@xpack-dev-tools/riscv-none-elf-gcc/14.1.0-1/.content/
/Users/ilg/Library/xPacks/\@xpack-dev-tools/riscv-none-elf-gcc/14.1.0-1/.content/
$ tree -L 2 /Users/ilg/Library/xPacks/\@xpack-dev-tools/riscv-none-elf-gcc/13.3.0-1/.content/
/Users/ilg/Library/xPacks/\@xpack-dev-tools/riscv-none-elf-gcc/13.3.0-1/.content/
├── README.md
├── bin
│   ├── riscv-none-elf-addr2line
Expand All @@ -123,7 +123,7 @@ $ tree -L 2 /Users/ilg/Library/xPacks/\@xpack-dev-tools/riscv-none-elf-gcc/14.1.
│   ├── riscv-none-elf-elfedit
│   ├── riscv-none-elf-g++
│   ├── riscv-none-elf-gcc
│   ├── riscv-none-elf-gcc-14.1.0
│   ├── riscv-none-elf-gcc-13.3.0
│   ├── riscv-none-elf-gcc-ar
│   ├── riscv-none-elf-gcc-nm
│   ├── riscv-none-elf-gcc-ranlib
Expand Down Expand Up @@ -187,7 +187,7 @@ $ tree -L 2 /Users/ilg/Library/xPacks/\@xpack-dev-tools/riscv-none-elf-gcc/14.1.
│   ├── lib
│   └── share
└── share
└── gcc-14.1.0
└── gcc-13.3.0

19 directories, 58 files
```
Expand Down Expand Up @@ -226,16 +226,16 @@ For more details please read the
### Versioning

The version strings used by the GCC project are three number strings
like `14.1.0`; to this string the xPack distribution adds a four number,
like `13.3.0`; to this string the xPack distribution adds a four number,
but since semver allows only three numbers, all additional ones can
be added only as pre-release strings, separated by a dash,
like `14.1.0-1`.
like `13.3.0-1`.
When published as a npm package, the version gets
a fifth number, like `14.1.0-1.1`.
a fifth number, like `13.3.0-1.1`.

Since adherence of third party packages to semver is not guaranteed,
it is recommended to use semver expressions like `^14.1.0` and `~14.1.0`
with caution, and prefer exact matches, like `14.1.0-1.1`.
it is recommended to use semver expressions like `^13.3.0` and `~13.3.0`
with caution, and prefer exact matches, like `13.3.0-1.1`.

## Maintainer info

Expand Down
2 changes: 1 addition & 1 deletion scripts/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
14.1.0-1
13.3.0-1

0 comments on commit e2fcf63

Please sign in to comment.