Skip to content

Commit

Permalink
prepare v18.1.8-1
Browse files Browse the repository at this point in the history
  • Loading branch information
@ilg-ul
ilg-ul committed Jun 21, 2024
1 parent 375d1fb commit f684c4e
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 46 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,17 @@

Entries in this file are in reverse chronological order.

## 2024-06-22

* v18.1.8-1 prepared
* 375d1fb package.json: bump deps
* ef54f13 re-generate workflows

## 2024-06-21

* 3eadee3 re-generate workflows
* c84d50d 17.0.6-3.1
* 5eba4df CHANGELOG: publish npm v17.0.6-3.1
* v17.0.6-3.1 published on npmjs.com
* 5e31ab4 package.json: update urls for 17.0.6-3.1 release
* 52a8c5c README update
Expand Down
70 changes: 35 additions & 35 deletions README-MAINTAINER.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ even X.Y.8.

### Increase the version

Determine the version (like `17.0.6`) and update the `scripts/VERSION`
file; the format is `17.0.6-3`. The fourth number is the xPack release number
Determine the version (like `18.1.8`) and update the `scripts/VERSION`
file; the format is `18.1.8-1`. The fourth number is the xPack release number
of this version. A fifth number will be added when publishing
the package on the `npm` server.

Expand All @@ -129,7 +129,7 @@ Check GitHub issues and pull requests:

- <https://github.com/xpack-dev-tools/clang-xpack/issues/>

and fix them; assign them to a milestone (like `17.0.6-3`).
and fix them; assign them to a milestone (like `18.1.8-1`).

### Check `README.md`

Expand All @@ -144,14 +144,14 @@ but in the web release files.

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

Use the new version, suffixed by `pre`, like `17.0.6-3.pre`.
Use the new version, suffixed by `pre`, like `18.1.8-1.pre`.

### Update `CHANGELOG.md`

- open the `CHANGELOG.md` file
- check if all previous fixed issues are in
- add a new entry like _* v17.0.6-3 prepared_
- commit with a message like _prepare v17.0.6-3_
- add a new entry like _* v18.1.8-1 prepared_
- commit with a message like _prepare v18.1.8-1_

### Update the version specific code

Expand All @@ -164,16 +164,16 @@ To keep the development repository fork in sync with the upstream LLVM
repository, in the `xpack-dev-tools/llvm-project` Git repo:

- fetch `upstream`
- checkout the `llvmorg-17.0.6` tag in detached state HEAD
- create a branch like `v17.0.6-xpack`
- checkout the `llvmorg-18.1.8` tag in detached state HEAD
- create a branch like `v18.1.8-xpack`
- cherry pick the commit to _clang: add /Library/... to headers search path_ from a previous release;
enable commit immediately
- push branch to `origin`
- add a `v17.0.6-3-xpack` tag; enable push to origin
- add a `v18.1.8-1-xpack` tag; enable push to origin
- select the commit with the patch
- save as patch
- move to `patches`
- rename `llvm-17.0.6-3.git.patch`
- rename `llvm-18.1.8-1.git.patch`

Note: the patch is required to fix the CLT library path up to
clang 17, starting with 18 the patch was accepted upstream.
Expand Down Expand Up @@ -307,8 +307,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/clang-xpack.git/build/darwin-x64/deploy
total 230824
-rw-r--r-- 1 ilg staff 101961650 Jun 20 11:43 xpack-clang-17.0.6-3-darwin-x64.tar.gz
-rw-r--r-- 1 ilg staff 105 Jun 20 11:43 xpack-clang-17.0.6-3-darwin-x64.tar.gz.sha
-rw-r--r-- 1 ilg staff 101961650 Jun 20 11:43 xpack-clang-18.1.8-1-darwin-x64.tar.gz
-rw-r--r-- 1 ilg staff 105 Jun 20 11:43 xpack-clang-18.1.8-1-darwin-x64.tar.gz.sha
```

The tests report is:
Expand Down Expand Up @@ -373,8 +373,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/clang-xpack.git/build/darwin-arm64/deploy
total 198208
-rw-r--r-- 1 ilg staff 95634615 Jun 20 10:48 xpack-clang-17.0.6-3-darwin-arm64.tar.gz
-rw-r--r-- 1 ilg staff 107 Jun 20 10:48 xpack-clang-17.0.6-3-darwin-arm64.tar.gz.sha
-rw-r--r-- 1 ilg staff 95634615 Jun 20 10:48 xpack-clang-18.1.8-1-darwin-arm64.tar.gz
-rw-r--r-- 1 ilg staff 107 Jun 20 10:48 xpack-clang-18.1.8-1-darwin-arm64.tar.gz.sha
```

The tests report is:
Expand Down Expand Up @@ -435,8 +435,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/clang-xpack.git/build/linux-x64/deploy
total 215724
-rw-r--r-- 1 ilg ilg 220891664 Jun 20 09:55 xpack-clang-17.0.6-3-linux-x64.tar.gz
-rw-r--r-- 1 ilg ilg 104 Jun 20 09:55 xpack-clang-17.0.6-3-linux-x64.tar.gz.sha
-rw-r--r-- 1 ilg ilg 220891664 Jun 20 09:55 xpack-clang-18.1.8-1-linux-x64.tar.gz
-rw-r--r-- 1 ilg ilg 104 Jun 20 09:55 xpack-clang-18.1.8-1-linux-x64.tar.gz.sha
```

The tests report is:
Expand Down Expand Up @@ -530,8 +530,8 @@ archive and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/xpack-dev-tools/clang-xpack.git/build/win32-x64/deploy
total 421076
-rw-r--r-- 1 ilg ilg 431171311 Jun 20 10:50 xpack-clang-17.0.6-3-win32-x64.zip
-rw-r--r-- 1 ilg ilg 101 Jun 20 10:50 xpack-clang-17.0.6-3-win32-x64.zip.sha
-rw-r--r-- 1 ilg ilg 431171311 Jun 20 10:50 xpack-clang-18.1.8-1-win32-x64.zip
-rw-r--r-- 1 ilg ilg 101 Jun 20 10:50 xpack-clang-18.1.8-1-win32-x64.zip.sha
```

The tests report is:
Expand Down Expand Up @@ -980,15 +980,15 @@ xattr -cr ${HOME}/Downloads/xpack-*
On GNU/Linux and macOS systems, use:

```sh
.../xpack-clang-17.0.6-3/bin/clang --version
xPack x86_64 clang version 17.0.6
.../xpack-clang-18.1.8-1/bin/clang --version
xPack x86_64 clang version 18.1.8
```

On Windows use:

```dos
...\xpack-clang-17.0.6-3\bin\clang --version
xPack x86_64 clang version 17.0.6
...\xpack-clang-18.1.8-1\bin\clang --version
xPack x86_64 clang version 18.1.8
```

### Running the tests with the system clang
Expand All @@ -1015,7 +1015,7 @@ bash ~/Work/xpack-dev-tools/clang-xpack.git/scripts/test.sh --system --skip-32

## Create a new GitHub pre-release draft

- in `CHANGELOG.md`, add the release date and a message like _* v17.0.6-3 released_
- in `CHANGELOG.md`, add the release date and a message like _* v18.1.8-1 released_
- commit with _CHANGELOG update_
- check and possibly update the `templates/body-github-release-liquid.md`
- push the `xpack-develop` branch
Expand All @@ -1026,8 +1026,8 @@ The workflow result and logs are available from the

The result is a
[draft pre-release](https://github.com/xpack-dev-tools/clang-xpack/releases/)
tagged like **v17.0.6-3** (mind the dash in the middle!) and
named like **xPack LLVM clang v17.0.6-3** (mind the dash),
tagged like **v18.1.8-1** (mind the dash in the middle!) and
named like **xPack LLVM clang v18.1.8-1** (mind the dash),
with all binaries attached.

- edit the draft and attach it to the `xpack-develop` branch (important!)
Expand All @@ -1051,7 +1051,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 LLVM clang v17.0.6-3 released_
use a message like _xPack LLVM clang v18.1.8-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 @@ -1092,18 +1092,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 17.0.6-3.1 release_ (without _v_)
_package.json: update urls for 18.1.8-1.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 _* v17.0.6-3.1 published on npmjs.com_
- commit with a message like _CHANGELOG: publish npm v17.0.6-3.1_
- update `CHANGELOG.md`, add a line like _* v18.1.8-1.1 published on npmjs.com_
- commit with a message like _CHANGELOG: publish npm v18.1.8-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 17.0.6-3.1`; the first 4 numbers are the same as the
- `npm version 18.1.8-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 All @@ -1127,13 +1127,13 @@ The Windows tests take more than 20 minutes to complete.
## Prepare the test results page

Download the `tests-report` artefact, unpack it and copy
the `17.0.6-3.md` file to the web site `pages/dev-tools/clang/tests` folder.
the `18.1.8-1.md` file to the web site `pages/dev-tools/clang/tests` folder.

Generating the tests results for a specific version can be done with the
command:

```bash
bash ~/Work/xpack-dev-tools/clang-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-test-xpm.sh --package-version 17.0.6-3.1
bash ~/Work/xpack-dev-tools/clang-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-test-xpm.sh --package-version 18.1.8-1.1
```

## Update the repo
Expand All @@ -1146,12 +1146,12 @@ bash ~/Work/xpack-dev-tools/clang-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/g
When the release is considered stable, promote it as `latest`:

- `npm dist-tag ls @xpack-dev-tools/clang`
- `npm dist-tag add @xpack-dev-tools/clang@17.0.6-3.1 latest`
- `npm dist-tag add @xpack-dev-tools/clang@18.1.8-1.1 latest`
- `npm dist-tag ls @xpack-dev-tools/clang`

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

- `npm unpublish @xpack-dev-tools/clang@17.0.6-3.1`
- `npm unpublish @xpack-dev-tools/clang@18.1.8-1.1`

## Update the Web

Expand All @@ -1173,7 +1173,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 LLVM clang v17.0.6-3 released**
- paste the release name like **xPack LLVM clang v18.1.8-1 released**
- paste the link to the Web page
[release](https://xpack.github.io/clang/releases/)
- click the **Tweet** button
Expand Down
18 changes: 9 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ After install, the package should create a structure like this (macOS files;
only the first two depth levels are shown):

```console
$ tree -L 2 /Users/ilg/Library/xPacks/\@xpack-dev-tools/clang/17.0.6-3.1/.content/
/Users/ilg/Library/xPacks/@xpack-dev-tools/clang/17.0.6-3.1/.content/
$ tree -L 2 /Users/ilg/Library/xPacks/\@xpack-dev-tools/clang/18.1.8-1.1/.content/
/Users/ilg/Library/xPacks/@xpack-dev-tools/clang/18.1.8-1.1/.content/
├── README.md
├── bin
│   ├── analyze-build
Expand Down Expand Up @@ -217,8 +217,8 @@ $ tree -L 2 /Users/ilg/Library/xPacks/\@xpack-dev-tools/clang/17.0.6-3.1/.conten
│   ├── libclang-cpp.dylib
│   ├── libclang.dylib
│   ├── libear
│   ├── liblldb.17.0.6.dylib
│   ├── liblldb.dylib -> liblldb.17.0.6.dylib
│   ├── liblldb.18.1.8.dylib
│   ├── liblldb.dylib -> liblldb.18.1.8.dylib
│   ├── libscanbuild
│   ├── libunwind.1.0.dylib
│   ├── libunwind.1.dylib -> libunwind.1.0.dylib
Expand Down Expand Up @@ -284,15 +284,15 @@ For more details please read the
### Versioning

The version strings used by the LLVM project are three number strings
like `17.0.6`; to this string the xPack distribution adds a four number,
like `18.1.8`; 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 `17.0.6-1`. When published as a npm package, the version gets
a fifth number, like `17.0.6-3.1`.
like `18.1.8-1`. When published as a npm package, the version gets
a fifth number, like `18.1.8-1.1`.

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

## Maintainer info

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@xpack-dev-tools/clang",
"version": "17.0.6-3.1",
"version": "17.0.6-1.1.pre",
"description": "A binary xPack with the LLVM clang executables",
"main": "",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion scripts/VERSION
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
17.0.6-3
18.1.8-1

0 comments on commit f684c4e

Please sign in to comment.