Skip to content
This repository has been archived by the owner on Feb 28, 2023. It is now read-only.

Commit

Permalink
README-*: update for 8.3.0-1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@ilg-ul
ilg-ul committed Jul 3, 2020
1 parent c2ea24f commit afa5533
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 48 deletions.
51 changes: 25 additions & 26 deletions README-BUILD.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -298,10 +298,10 @@ on a macOS system, due to Docker specifics, it is faster to build the
GNU/Linux and Windows binaries on a GNU/Linux system and the macOS binary
separately.

### Build the GNU/Linux and Windows binaries
### Build the Intel GNU/Linux and Windows binaries

The current platform for GNU/Linux and Windows production builds is an
Ubuntu Server 18 LTS, running on an Intel NUC8i7BEH mini PC with 32 GB of RAM
The current platform for Intel GNU/Linux and Windows production builds is a
Debian 10, running on an Intel NUC8i7BEH mini PC with 32 GB of RAM
and 512 GB of fast M.2 SSD.

```console
Expand Down Expand Up @@ -383,14 +383,14 @@ their SHA signatures, created in the `deploy` folder:
```console
$ ls -l deploy
total 350108
-rw-r--r-- 1 ilg ilg 61981364 Apr 1 08:27 xpack-riscv-none-embed-gcc-8.2.0-3.1-linux-x32.tar.xz
-rw-r--r-- 1 ilg ilg 140 Apr 1 08:27 xpack-riscv-none-embed-gcc-8.2.0-3.1-linux-x32.tar.xz.sha
-rw-r--r-- 1 ilg ilg 61144048 Apr 1 08:19 xpack-riscv-none-embed-gcc-8.2.0-3.1-linux-x64.tar.xz
-rw-r--r-- 1 ilg ilg 140 Apr 1 08:19 xpack-riscv-none-embed-gcc-8.2.0-3.1-linux-x64.tar.xz.sha
-rw-r--r-- 1 ilg ilg 112105889 Apr 1 08:29 xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x32.zip
-rw-r--r-- 1 ilg ilg 134 Apr 1 08:29 xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x32.zip.sha
-rw-r--r-- 1 ilg ilg 123181226 Apr 1 08:21 xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x64.zip
-rw-r--r-- 1 ilg ilg 134 Apr 1 08:21 xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x64.zip.sha
-rw-r--r-- 1 ilg ilg 61981364 Apr 1 08:27 xpack-riscv-none-embed-gcc-8.3.0-1.2-linux-x32.tar.gz
-rw-r--r-- 1 ilg ilg 140 Apr 1 08:27 xpack-riscv-none-embed-gcc-8.3.0-1.2-linux-x32.tar.gz.sha
-rw-r--r-- 1 ilg ilg 61144048 Apr 1 08:19 xpack-riscv-none-embed-gcc-8.3.0-1.2-linux-x64.tar.gz
-rw-r--r-- 1 ilg ilg 140 Apr 1 08:19 xpack-riscv-none-embed-gcc-8.3.0-1.2-linux-x64.tar.gz.sha
-rw-r--r-- 1 ilg ilg 112105889 Apr 1 08:29 xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x32.zip
-rw-r--r-- 1 ilg ilg 134 Apr 1 08:29 xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x32.zip.sha
-rw-r--r-- 1 ilg ilg 123181226 Apr 1 08:21 xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x64.zip
-rw-r--r-- 1 ilg ilg 134 Apr 1 08:21 xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x64.zip.sha
```

To copy the files from the build machine to the current development
Expand All @@ -399,7 +399,7 @@ folder in a terminal and use `scp`:

```console
$ cd ~/Work/riscv-none-embed-gcc-*/deploy
$ scp * ilg@ilg-wks.local:Downloads/xpack-binaries/riscv
$ scp * ilg@wks:Downloads/xpack-binaries/riscv
```

#### Build the Arm GNU/Linux binaries
Expand Down Expand Up @@ -468,10 +468,10 @@ archives and their SHA signatures, created in the `deploy` folder:
$ cd ~/Work/riscv-none-embed-gcc-*
$ ls -l deploy
total 13076
-rw-r--r-- 1 ilg ilg 115361011 Jul 26 11:57 xpack-arm-none-eabi-gcc-9.2.1-1.2-linux-arm64.tgz
-rw-r--r-- 1 ilg ilg 114 Jul 26 11:57 xpack-arm-none-eabi-gcc-9.2.1-1.2-linux-arm64.tgz.sha
-rw-r--r-- 1 ilg ilg 115361011 Jul 26 11:57 xpack-arm-none-eabi-gcc-9.2.1-1.2-linux-arm.tgz
-rw-r--r-- 1 ilg ilg 114 Jul 26 11:57 xpack-arm-none-eabi-gcc-9.2.1-1.2-linux-arm.tgz.sha
-rw-r--r-- 1 ilg ilg 115361011 Jul 26 11:57 xpack-arm-none-eabi-gcc-8.3.0-1.2-linux-arm64.tar.gz
-rw-r--r-- 1 ilg ilg 114 Jul 26 11:57 xpack-arm-none-eabi-gcc-8.3.0-1.2-linux-arm64.tar.gz.sha
-rw-r--r-- 1 ilg ilg 115361011 Jul 26 11:57 xpack-arm-none-eabi-gcc-8.3.0-1.2-linux-arm.tar.gz
-rw-r--r-- 1 ilg ilg 114 Jul 26 11:57 xpack-arm-none-eabi-gcc-8.3.0-1.2-linux-arm.tar.gz.sha
```

To copy the files from the build machine to the current development
Expand All @@ -486,8 +486,7 @@ $ scp * ilg@wks:Downloads/xpack-binaries/riscv
### Build the macOS binary

The current platform for macOS production builds is a macOS 10.10.5
VirtualBox image running on the same macMini with 16 GB of RAM and a
fast SSD.
running on a MacBookPro with 16 GB of RAM and a fast SSD.

```console
$ ssh xbbm
Expand Down Expand Up @@ -517,8 +516,8 @@ and its SHA signature, created in the `deploy` folder:
```console
$ ls -l deploy
total 216064
-rw-r--r-- 1 ilg staff 110620198 Jul 24 16:35 xpack-riscv-none-embed-gcc-8.2.0-3.1-darwin-x64.tgz
-rw-r--r-- 1 ilg staff 134 Jul 24 16:35 xpack-riscv-none-embed-gcc-8.2.0-3.1-darwin-x64.tgz.sha
-rw-r--r-- 1 ilg staff 110620198 Jul 24 16:35 xpack-riscv-none-embed-gcc-8.3.0-1.2-darwin-x64.tar.gz
-rw-r--r-- 1 ilg staff 134 Jul 24 16:35 xpack-riscv-none-embed-gcc-8.3.0-1.2-darwin-x64.tar.gz.sha
```

To copy the files from the build machine to the current development
Expand All @@ -527,7 +526,7 @@ folder in a terminal and use `scp`:

```console
$ cd ~/Work/riscv-none-embed-gcc-*/deploy
$ scp * ilg@ilg-wks.local:Downloads/xpack-binaries/riscv
$ scp * ilg@wks:Downloads/xpack-binaries/riscv
```

## Run a test build
Expand Down Expand Up @@ -621,7 +620,7 @@ build folder, it might be necessary to run a recursive `chown`.
Set the release explicitly in the environment:

```console
$ RELEASE_VERSION=8.2.0-3.1 bash ~/Downloads/riscv-none-embed-gcc-xpack.git/scripts/build.sh --all --jobs 8
$ RELEASE_VERSION=8.3.0-1.2 bash ~/Downloads/riscv-none-embed-gcc-xpack.git/scripts/build.sh --all --jobs 8
$ RELEASE_VERSION=8.3.0-1.1 bash ~/Downloads/riscv-none-embed-gcc-xpack.git/scripts/build.sh --all --jobs 8
```

Expand All @@ -642,8 +641,8 @@ program from there. For example on macOS the output should
look like:

```console
$ /Users/ilg/Downloads/xPacks/riscv-none-embed-gcc/8.2.0-3.1/bin/riscv-none-embed-gcc --version
riscv-none-embed-gcc (xPack RISC-V Embedded GCC, 64-bit) 8.2.0
$ /Users/ilg/Downloads/xPacks/riscv-none-embed-gcc/8.3.0-1.2/bin/riscv-none-embed-gcc --version
riscv-none-embed-gcc (xPack RISC-V Embedded GCC, 64-bit) 8.3.0
```

## Travis tests
Expand All @@ -659,8 +658,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/opt/xPacks/riscv-none-embed-gcc/8.2.1-1.1
/Users/ilg/opt/gnu-mcu-eclipse/riscv-none-embed-gcc/8.2.1-1.1
$ tree -L 2 /Users/ilg/opt/xPacks/riscv-none-embed-gcc/8.3.0-1.2
/Users/ilg/opt/gnu-mcu-eclipse/riscv-none-embed-gcc/8.3.0-1.2
├── README.md
├── riscv-none-embed
│   ├── bin
Expand Down
68 changes: 46 additions & 22 deletions README-PUBLISH.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

Before starting the build, perform some checks.

### Check possible open issues

Check GitHub [issues](https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/issues)
and fix them; do not close them yet.

### Check if repos are up-to-date

Be sure everything is committed and pushed
Expand All @@ -14,9 +19,9 @@ Be sure everything is committed and pushed

### Check tags

The names should look like `v8.2.0-2.2`.
The names should look like `v8.3.0-1.2`.

For the binutils-gdb repo, a separate tag like `v8.2.0-2.2-gdb` should be
For the binutils-gdb repo, a separate tag like `v8.3.0-1.2-gdb` should be
present, for the gdb build.

### Check the `CHANGELOG.md` file
Expand Down Expand Up @@ -57,10 +62,12 @@ For this, on each platform (Mac, GNU/Linux 64/32, Windows 64/32):
folder, by replacing a dash with a space; this will test paths with spaces;
on Windows the current paths always use spaces, so renaming is not needed;
- clone this repo locally; on Windows use the Git console;

```console
$ git clone --recurse-submodules https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack.git \
~/Downloads/riscv-none-embed-gcc-xpack.git
```

- in a separate workspace, Import → General → Existing Projects into Workspace
the Eclipse projects available in the
`tests/eclipse` folder of the build repo; more details in the
Expand All @@ -82,6 +89,7 @@ $ git clone --recurse-submodules https://github.com/xpack-dev-tools/riscv-none-e
- (don't miss the LTO cases, since in the past they had problems)
- to test the Python debugger, start it with `--version`; on Windows, to
test with different versions, set the path with:

```
C:\Users\ilg>set PYTHONHOME=C:\Python27.16
```
Expand All @@ -92,12 +100,12 @@ C:\Users\ilg>set PYTHONHOME=C:\Python27.16
- commit and push the repo
- go to the [GitHub Releases](https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases) page
- click **Draft a new release**
- name the tag like **v8.2.0-2.2** (mind the dash in the middle!)
- select the target branch (like sifive-gcc-8.2.0-gme)
- name the release like **xPack GNU RISC-V Embedded GCC v8.2.0-2.2**
- name the tag like **v8.3.0-1.2** (mind the dash in the middle!)
- select the target branch (like sifive-gcc-8.3.0-gme)
- name the release like **xPack GNU RISC-V Embedded GCC v8.3.0-1.2**
(mind the dash and the space)
- as description
- add a downloads badge like `![Github Releases (by Release)](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-embed-gcc-xpack/v8.2.0-2.2/total.svg)`; use empty URL for now
- add a downloads badge like `![Github Releases (by Release)](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-embed-gcc-xpack/v8.3.0-1.2/total.svg)`; use empty URL for now
- draft a short paragraph explaining what are the main changes
- **attach binaries** and SHA (drag and drop from the archives folder will do it)
- **enable** the **pre-release** button
Expand All @@ -106,14 +114,24 @@ C:\Users\ilg>set PYTHONHOME=C:\Python27.16
Note: at this moment the system should send a notification to all clients
watching this project.

## Run the Travis tests

As URL, use something like

```
base_url="https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases/download/v8.3.0-1.2/"
```

For more details, see `tests/scripts/README.md`.

## Prepare a new blog post

In the `xpack.github.io` web Git:

- add a new file to `_posts/releases/riscv-none-embed-gcc`
- name the file like `2018-05-06-riscv-none-embed-gcc-v8-2-0-2-2-released.md`
- name the post like: **xPack GNU RISC-V Embedded GCC v8.2.0-2.2 released**.
- as `download_url` use the tagged URL like `https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases/tag/v8.2.0-2.2/`
- name the file like `2020-07-04-riscv-none-embed-gcc-v8-3-0-1-2-released.md`
- name the post like: **xPack GNU RISC-V Embedded GCC v8.3.0-1.2 released**.
- as `download_url` use the tagged URL like `https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases/tag/v8.3.0-1.2/`
- update the `date:` field with the current date
- copy the list of commit IDs from the `README-<version>.sh` file
- generate the list of multilibs and copy/paste
Expand All @@ -132,19 +150,19 @@ Copy/paste the build report at the end of the post as:
The SHA-256 hashes for the files are:

5e10320563e49dd31a33a032496547375d0e07191df727d393e26daa14d3f526
xpack-riscv-none-embed-gcc-8.2.0-3.1-darwin-x64.tgz
xpack-riscv-none-embed-gcc-8.3.0-1.2-darwin-x64.tgz

fdb6ab5badd0820e0562c288b1ec88566f8589f5fa26d81a0f57a2b95213d0cc
xpack-riscv-none-embed-gcc-8.2.0-3.1-linux-x32.tgz
xpack-riscv-none-embed-gcc-8.3.0-1.2-linux-x32.tgz

dd6985729df5c2182cc5ce699013146b4addc80cbe231a7b62ec89d095e81aca
xpack-riscv-none-embed-gcc-8.2.0-3.1-linux-x64.tgz
xpack-riscv-none-embed-gcc-8.3.0-1.2-linux-x64.tgz

737f95fb3129b0e7f67c48fea39b844f574c379768bd0ea5088a6e976f8f7b14
xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x32.zip
xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x32.zip

98ac277287d8c51cc1c5f83a5a9945951bd8d5806b4570b41eea2c306e141a3b
xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x64.zip
xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x64.zip
```

If you missed this, `cat` the content of the `.sha` files:
Expand All @@ -157,7 +175,7 @@ $ cat *.sha
## Update the Web

- commit the `xpack.github.io` web Git; use a message
like **xPack GNU RISC-V Embedded GCC v8.2.0-2.2 released**
like **xPack GNU RISC-V Embedded GCC v8.3.0-1.2 released**
- adjust timestamps
- wait for the GitHub Pages build to complete
- remember the post URL, since it must be updated in the release page
Expand All @@ -169,21 +187,28 @@ $ cat *.sha
- update the `baseUrl:` with the file URLs (including the tag/version)
- from the release, copy the SHA & file names
- check the executable names
- commit all changes, use a message like `package.json: update urls for 8.2.1-2.2 release` (without `v`)
- commit all changes, use a message like `package.json: update urls for 8.3.0-1.2 release` (without `v`)
- check the latest commits `npm run git-log`
- update `CHANGELOG.md`; commit with a message like
_CHANGELOG: prepare npm v8.2.1-2.2.1_
- `npm version 8.2.1-2.2.1`; the first 5 numbers are the same as the
_CHANGELOG: prepare npm v8.3.0-1.2.1_
- `npm version 8.3.0-1.2.1`; the first 5 numbers are the same as the
GitHub release; the sixth number is the npm specific version
- `npm pack` and check the content of the archive
- push all changes to GitHub
- `npm publish` (use `--access public` when publishing for the first time)
- `npm publish --tag next` (use `--access public` when publishing for the first time)

When the release is considered stable, promote it as `latest`:

- `npm dist-tag ls @xpack-dev-tools/riscv-none-embed-gcc`
- `npm dist-tag add @xpack-dev-tools/riscv-none-embed-gcc@8.3.0-1.2.1 latest`
- `npm dist-tag ls @xpack-dev-tools/riscv-none-embed-gcc`

## Test npm binaries

Install the binaries on all platforms.

```console
$ xpm install --global @xpack-dev-tools/riscv-none-embed-gcc@latest
$ xpm install --global @xpack-dev-tools/riscv-none-embed-gcc@next
```

## Create a final GitHub release
Expand All @@ -198,7 +223,7 @@ $ xpm install --global @xpack-dev-tools/riscv-none-embed-gcc@latest

- in a separate browser windows, open [TweetDeck](https://tweetdeck.twitter.com/)
- using the `@xpack_project` account
- paste the release name like **xPack GNU RISC-V Embedded GCC v8.2.0-2.2 released**
- paste the release name like **xPack GNU RISC-V Embedded GCC v8.3.0-1.2 released**
- paste the link to the Web Page release
- click the **Tweet** button

Expand All @@ -208,4 +233,3 @@ Add a new topic in the **Announcements** category of the
[SiFive forums](https://forums.sifive.com/c/announcements).

Send an email to <sw-dev@groups.riscv.org>.

0 comments on commit afa5533

Please sign in to comment.