Skip to content
This repository was archived by the owner on Nov 5, 2019. It is now read-only.

Commit 71f80f6

Browse files
committed
PUBLISH.md: update the build section
1 parent b8a0a8b commit 71f80f6

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

PUBLISH.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,57 @@
11
# How to publish the GNU MCU Eclipse QEMU binaries?
22

3-
## Update the Change log
3+
## Build
4+
5+
Before starting the build, perform some checks.
46

5-
Open the `CHANGELOG.txt` file from
6-
`gnu-mcu-eclipse/qemu-build.git` project git, and copy
7-
entries to the web git.
7+
### Check the CHANGELOG file
8+
9+
10+
## Update the Change log
811

9-
In the web git, add new entries to the
10-
[Change log](https://gnu-mcu-eclipse.github.io/qemu/change-log/)
11-
(`pages/qemu/change-log.md`), grouped by days.
12+
Open the `CHANGELOG.txt` file from `gnu-mcu-eclipse/qemu-build.git`
13+
and check if all new entries are in.
1214

1315
Note: if you missed to update the `CHANGELOG.txt` before starting the build,
1416
edit the file and rerun the build, it should take only a few minutes to
1517
recreate the archives with the correct file.
1618

17-
## Edit the build script
19+
### Check the version
1820

19-
Edit the `VERSION` file to refer to the actual release.
21+
The `VERSION` file should refer to the actual release.
2022

2123
## Push the build script git
2224

23-
Push `gnu-mcu-eclipse/qemu-build.git` to GitHub.
25+
In `gnu-mcu-eclipse/qemu-build.git`, if necessary, merge
26+
the `develop` branch into `master`.
27+
28+
Push it to GitHub.
2429

2530
Possibly push the helper project too.
2631

27-
## Build
32+
### Run the build scripts
2833

29-
Follow the instructions on the
34+
When everything is ready, follow the instructions on the
3035
[build](https://github.com/gnu-mcu-eclipse/qemu-build/blob/master/README.md)
3136
page.
3237

38+
## Test
39+
40+
Install the binaries on all supported platforms and check if they are
41+
functional.
42+
3343
## Create a new GitHub pre-release
3444

3545
- go to the [GitHub Releases](https://github.com/gnu-mcu-eclipse/qemu/releases) page
3646
- click **Draft a new release**
3747
- name the tag like **v2.8.0-3-20180523** (mind the dashes in the middle!)
38-
- name the release like **GNU MCU Eclipse QEMU v2.8.0-3-20180523**
48+
- name the release like **GNU MCU Eclipse QEMU v2.8.0-3 20180523**
3949
(mind the dashes)
4050
- as description
4151
- add a downloads badge like `[![Github Releases (by Release)](https://img.shields.io/github/downloads/gnu-mcu-eclipse/qemu/v2.8.0-3-20180523/total.svg)]()`; use empty URL for now
4252
- draft a short paragraph explaining what are the main changes
4353
- **attach binaries** and SHA (drag and drop from the archives folder will do it)
44-
- enable the pre-release button
54+
- **enable** the pre-release button
4555
- click the **Publish Release** button
4656

4757
Note: at this moment the system should send a notification to all clients watching this project.
@@ -53,7 +63,7 @@ In the `gnu-mcu-eclipse.github.io-source.git` web git:
5363

5464
- add a new file to `_posts/qemu/releases`
5565
- name the file like `2018-05-23-qemu-v2-8-0-3-20180523-released.md`
56-
- name the post like: **GNU MCU Eclipse QEMU v2.8.0-3-20180523 released**.
66+
- name the post like: **GNU MCU Eclipse QEMU v2.8.0-3 20180523 released**.
5767
- as `download_url` use the tagged URL like `https://github.com/gnu-mcu-eclipse/qemu/releases/tag/v2.8.0-3-20180523/`
5868
- update the `date:` field with the current date
5969

@@ -89,7 +99,7 @@ gnu-mcu-eclipse-qemu-2.8.0-3-20180523-0703-win64.zip
8999
## Update the Web
90100

91101
- commit the `gnu-mcu-eclipse.github.io-source` project; use a message
92-
like **GNU MCU Eclipse QEMU v2.8.0-3 released**
102+
like **GNU MCU Eclipse QEMU v2.8.0-3 20180523 released**
93103
- wait for the Travis build to complete; occasionally links to not work,
94104
and might need to restart the build.
95105
- remember the post URL, since it must be updated in the release page

0 commit comments

Comments
 (0)