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

Commit afa5533

Browse files
committed
README-*: update for 8.3.0-1.2
1 parent c2ea24f commit afa5533

File tree

2 files changed

+71
-48
lines changed

2 files changed

+71
-48
lines changed

README-BUILD.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -298,10 +298,10 @@ on a macOS system, due to Docker specifics, it is faster to build the
298298
GNU/Linux and Windows binaries on a GNU/Linux system and the macOS binary
299299
separately.
300300

301-
### Build the GNU/Linux and Windows binaries
301+
### Build the Intel GNU/Linux and Windows binaries
302302

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

307307
```console
@@ -383,14 +383,14 @@ their SHA signatures, created in the `deploy` folder:
383383
```console
384384
$ ls -l deploy
385385
total 350108
386-
-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
387-
-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
388-
-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
389-
-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
390-
-rw-r--r-- 1 ilg ilg 112105889 Apr 1 08:29 xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x32.zip
391-
-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
392-
-rw-r--r-- 1 ilg ilg 123181226 Apr 1 08:21 xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x64.zip
393-
-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
386+
-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
387+
-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
388+
-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
389+
-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
390+
-rw-r--r-- 1 ilg ilg 112105889 Apr 1 08:29 xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x32.zip
391+
-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
392+
-rw-r--r-- 1 ilg ilg 123181226 Apr 1 08:21 xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x64.zip
393+
-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
394394
```
395395

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

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

405405
#### Build the Arm GNU/Linux binaries
@@ -468,10 +468,10 @@ archives and their SHA signatures, created in the `deploy` folder:
468468
$ cd ~/Work/riscv-none-embed-gcc-*
469469
$ ls -l deploy
470470
total 13076
471-
-rw-r--r-- 1 ilg ilg 115361011 Jul 26 11:57 xpack-arm-none-eabi-gcc-9.2.1-1.2-linux-arm64.tgz
472-
-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
473-
-rw-r--r-- 1 ilg ilg 115361011 Jul 26 11:57 xpack-arm-none-eabi-gcc-9.2.1-1.2-linux-arm.tgz
474-
-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
471+
-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
472+
-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
473+
-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
474+
-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
475475
```
476476

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

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

492491
```console
493492
$ ssh xbbm
@@ -517,8 +516,8 @@ and its SHA signature, created in the `deploy` folder:
517516
```console
518517
$ ls -l deploy
519518
total 216064
520-
-rw-r--r-- 1 ilg staff 110620198 Jul 24 16:35 xpack-riscv-none-embed-gcc-8.2.0-3.1-darwin-x64.tgz
521-
-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
519+
-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
520+
-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
522521
```
523522

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

528527
```console
529528
$ cd ~/Work/riscv-none-embed-gcc-*/deploy
530-
$ scp * ilg@ilg-wks.local:Downloads/xpack-binaries/riscv
529+
$ scp * ilg@wks:Downloads/xpack-binaries/riscv
531530
```
532531

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

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

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

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

649648
## Travis tests
@@ -659,8 +658,8 @@ After install, the package should create a structure like this (only the
659658
first two depth levels are shown):
660659

661660
```console
662-
$ tree -L 2 /Users/ilg/opt/xPacks/riscv-none-embed-gcc/8.2.1-1.1
663-
/Users/ilg/opt/gnu-mcu-eclipse/riscv-none-embed-gcc/8.2.1-1.1
661+
$ tree -L 2 /Users/ilg/opt/xPacks/riscv-none-embed-gcc/8.3.0-1.2
662+
/Users/ilg/opt/gnu-mcu-eclipse/riscv-none-embed-gcc/8.3.0-1.2
664663
├── README.md
665664
├── riscv-none-embed
666665
│   ├── bin

README-PUBLISH.md

Lines changed: 46 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
Before starting the build, perform some checks.
66

7+
### Check possible open issues
8+
9+
Check GitHub [issues](https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/issues)
10+
and fix them; do not close them yet.
11+
712
### Check if repos are up-to-date
813

914
Be sure everything is committed and pushed
@@ -14,9 +19,9 @@ Be sure everything is committed and pushed
1419

1520
### Check tags
1621

17-
The names should look like `v8.2.0-2.2`.
22+
The names should look like `v8.3.0-1.2`.
1823

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

2227
### Check the `CHANGELOG.md` file
@@ -57,10 +62,12 @@ For this, on each platform (Mac, GNU/Linux 64/32, Windows 64/32):
5762
folder, by replacing a dash with a space; this will test paths with spaces;
5863
on Windows the current paths always use spaces, so renaming is not needed;
5964
- clone this repo locally; on Windows use the Git console;
65+
6066
```console
6167
$ git clone --recurse-submodules https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack.git \
6268
~/Downloads/riscv-none-embed-gcc-xpack.git
6369
```
70+
6471
- in a separate workspace, Import → General → Existing Projects into Workspace
6572
the Eclipse projects available in the
6673
`tests/eclipse` folder of the build repo; more details in the
@@ -82,6 +89,7 @@ $ git clone --recurse-submodules https://github.com/xpack-dev-tools/riscv-none-e
8289
- (don't miss the LTO cases, since in the past they had problems)
8390
- to test the Python debugger, start it with `--version`; on Windows, to
8491
test with different versions, set the path with:
92+
8593
```
8694
C:\Users\ilg>set PYTHONHOME=C:\Python27.16
8795
```
@@ -92,12 +100,12 @@ C:\Users\ilg>set PYTHONHOME=C:\Python27.16
92100
- commit and push the repo
93101
- go to the [GitHub Releases](https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases) page
94102
- click **Draft a new release**
95-
- name the tag like **v8.2.0-2.2** (mind the dash in the middle!)
96-
- select the target branch (like sifive-gcc-8.2.0-gme)
97-
- name the release like **xPack GNU RISC-V Embedded GCC v8.2.0-2.2**
103+
- name the tag like **v8.3.0-1.2** (mind the dash in the middle!)
104+
- select the target branch (like sifive-gcc-8.3.0-gme)
105+
- name the release like **xPack GNU RISC-V Embedded GCC v8.3.0-1.2**
98106
(mind the dash and the space)
99107
- as description
100-
- 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
108+
- 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
101109
- draft a short paragraph explaining what are the main changes
102110
- **attach binaries** and SHA (drag and drop from the archives folder will do it)
103111
- **enable** the **pre-release** button
@@ -106,14 +114,24 @@ C:\Users\ilg>set PYTHONHOME=C:\Python27.16
106114
Note: at this moment the system should send a notification to all clients
107115
watching this project.
108116

117+
## Run the Travis tests
118+
119+
As URL, use something like
120+
121+
```
122+
base_url="https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases/download/v8.3.0-1.2/"
123+
```
124+
125+
For more details, see `tests/scripts/README.md`.
126+
109127
## Prepare a new blog post
110128

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

113131
- add a new file to `_posts/releases/riscv-none-embed-gcc`
114-
- name the file like `2018-05-06-riscv-none-embed-gcc-v8-2-0-2-2-released.md`
115-
- name the post like: **xPack GNU RISC-V Embedded GCC v8.2.0-2.2 released**.
116-
- 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/`
132+
- name the file like `2020-07-04-riscv-none-embed-gcc-v8-3-0-1-2-released.md`
133+
- name the post like: **xPack GNU RISC-V Embedded GCC v8.3.0-1.2 released**.
134+
- 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/`
117135
- update the `date:` field with the current date
118136
- copy the list of commit IDs from the `README-<version>.sh` file
119137
- generate the list of multilibs and copy/paste
@@ -132,19 +150,19 @@ Copy/paste the build report at the end of the post as:
132150
The SHA-256 hashes for the files are:
133151

134152
5e10320563e49dd31a33a032496547375d0e07191df727d393e26daa14d3f526
135-
xpack-riscv-none-embed-gcc-8.2.0-3.1-darwin-x64.tgz
153+
xpack-riscv-none-embed-gcc-8.3.0-1.2-darwin-x64.tgz
136154

137155
fdb6ab5badd0820e0562c288b1ec88566f8589f5fa26d81a0f57a2b95213d0cc
138-
xpack-riscv-none-embed-gcc-8.2.0-3.1-linux-x32.tgz
156+
xpack-riscv-none-embed-gcc-8.3.0-1.2-linux-x32.tgz
139157

140158
dd6985729df5c2182cc5ce699013146b4addc80cbe231a7b62ec89d095e81aca
141-
xpack-riscv-none-embed-gcc-8.2.0-3.1-linux-x64.tgz
159+
xpack-riscv-none-embed-gcc-8.3.0-1.2-linux-x64.tgz
142160

143161
737f95fb3129b0e7f67c48fea39b844f574c379768bd0ea5088a6e976f8f7b14
144-
xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x32.zip
162+
xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x32.zip
145163

146164
98ac277287d8c51cc1c5f83a5a9945951bd8d5806b4570b41eea2c306e141a3b
147-
xpack-riscv-none-embed-gcc-8.2.0-3.1-win32-x64.zip
165+
xpack-riscv-none-embed-gcc-8.3.0-1.2-win32-x64.zip
148166
```
149167

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

159177
- commit the `xpack.github.io` web Git; use a message
160-
like **xPack GNU RISC-V Embedded GCC v8.2.0-2.2 released**
178+
like **xPack GNU RISC-V Embedded GCC v8.3.0-1.2 released**
161179
- adjust timestamps
162180
- wait for the GitHub Pages build to complete
163181
- remember the post URL, since it must be updated in the release page
@@ -169,21 +187,28 @@ $ cat *.sha
169187
- update the `baseUrl:` with the file URLs (including the tag/version)
170188
- from the release, copy the SHA & file names
171189
- check the executable names
172-
- commit all changes, use a message like `package.json: update urls for 8.2.1-2.2 release` (without `v`)
190+
- commit all changes, use a message like `package.json: update urls for 8.3.0-1.2 release` (without `v`)
191+
- check the latest commits `npm run git-log`
173192
- update `CHANGELOG.md`; commit with a message like
174-
_CHANGELOG: prepare npm v8.2.1-2.2.1_
175-
- `npm version 8.2.1-2.2.1`; the first 5 numbers are the same as the
193+
_CHANGELOG: prepare npm v8.3.0-1.2.1_
194+
- `npm version 8.3.0-1.2.1`; the first 5 numbers are the same as the
176195
GitHub release; the sixth number is the npm specific version
177196
- `npm pack` and check the content of the archive
178197
- push all changes to GitHub
179-
- `npm publish` (use `--access public` when publishing for the first time)
198+
- `npm publish --tag next` (use `--access public` when publishing for the first time)
199+
200+
When the release is considered stable, promote it as `latest`:
201+
202+
- `npm dist-tag ls @xpack-dev-tools/riscv-none-embed-gcc`
203+
- `npm dist-tag add @xpack-dev-tools/[email protected] latest`
204+
- `npm dist-tag ls @xpack-dev-tools/riscv-none-embed-gcc`
180205

181206
## Test npm binaries
182207

183208
Install the binaries on all platforms.
184209

185210
```console
186-
$ xpm install --global @xpack-dev-tools/riscv-none-embed-gcc@latest
211+
$ xpm install --global @xpack-dev-tools/riscv-none-embed-gcc@next
187212
```
188213

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

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

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

210235
Send an email to <[email protected]>.
211-

0 commit comments

Comments
 (0)