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

Commit

Permalink
PUBLISH.md: update after 0.10.0-12 release
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Apr 23, 2019
1 parent 23ad80d commit 20b0eca
Showing 1 changed file with 68 additions and 48 deletions.
116 changes: 68 additions & 48 deletions PUBLISH.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,71 @@
# How to publish the GNU MCU Eclipse OpenOCD binaries?

## Update the Change log
## Build

Generally, apart from packing, there should be no local changes compared
to the original OpenOCD distribution.
Before starting the build, perform some checks.

### Check the CHANGELOG file

Open the `CHANGELOG.txt` file from
`gnu-mcu-eclipse/openocd-build.git` project git, and copy
entries to the web git.
`gnu-mcu-eclipse/openocd-build.git` project git, and and check if all
new entries are in.

In the web git, add new entries to the
[Change log](https://gnu-mcu-eclipse.github.io/openocd/change-log/)
(`pages/openocd/change-log.md`), grouped by days.
Generally, apart from packing, there should be no local changes compared
to the original OpenOCD distribution.

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

## Edit the build script
### Check the version

Edit the `VERSION` file to refer to the actual release.
The `VERSION` file should refer to the actual release.

## Push the build script git
### Push the build script git

Push `gnu-mcu-eclipse/openocd-build.git` to GitHub.
In `gnu-mcu-eclipse/openocd-build.git`, if necessary, merge
the `develop` branch into `master`.

Push it to GitHub.

Possibly push the helper project too.

## Build
### Run the build scripts

Follow the instructions on the
When everything is ready, follow the instructions on the
[build](https://github.com/gnu-mcu-eclipse/openocd-build/blob/master/README.md)
page.

## Test

Install the binaries on all supported platforms and check if they are
functional.

## Create a new GitHub pre-release

- go to the [GitHub Releases](https://github.com/gnu-mcu-eclipse/openocd/releases) page
- click **Draft a new release**
- name the tag like **v0.10.0-8-20180512** (mind the dashes in the middle!)
- select the `master` branch
- name the release like **GNU MCU Eclipse OpenOCD v0.10.0-8 20180512**
(mind the dash and the space)
- as description
- add a downloads badge like `[![Github Releases (by Release)](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/v0.10.0-8-20180512/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
- click the **Publish Release** button

Note: at this moment the system should send a notification to all clients watching this project.

## Prepare a new blog post

In the `gnu-mcu-eclipse.github.io-source.git` web git:

- add a new file to `_posts/openocd/releases`
- name the file like `2018-05-12-openocd-v0-10-0-8-20180512-released.md`
- name the post like: **GNU MCU Eclipse OpenOCD v0.10.0-8-20180512 released**.
- as `download_url` use the generic `https://github.com/gnu-mcu-eclipse/openocd/releases/`
- name the post like: **GNU MCU Eclipse OpenOCD v0.10.0-8 20180512 released**.
- as `download_url` use the tagged URL `https://github.com/gnu-mcu-eclipse/openocd/releases/tag/v0.10.0-8-20180512/`
- update the `date:` field with the current date

If any, close [issues](https://github.com/gnu-mcu-eclipse/openocd/issues)
Expand Down Expand Up @@ -72,52 +97,38 @@ gnu-mcu-eclipse-openocd-0.10.0-8-20180512-1921-win32.zip
gnu-mcu-eclipse-openocd-0.10.0-8-20180512-1921-win64.zip
```

If you missed this, `cat` the content of the `.sha` files:

```console
$ cd deploy
$ cat *.sha
```

## Update the Web

- commit the `gnu-mcu-eclipse.github.io-source` project; use a message
like **GNU MCU Eclipse OpenOCD v0.10.0-8 released**
like **GNU MCU Eclipse OpenOCD v0.10.0-8 20180512 released**
- wait for the Travis build to complete; occasionally links to not work,
and might need to restart the build.
- remember the post URL, since it must be updated in the release page

Note: initially the link to binaries points to the parent releases folder,
otherwise Travis will complain and do not publish the site to
`gnu-mcu-eclipse.github.io`.

## Create a new GitHub release

- go to the [GitHub Releases](https://github.com/gnu-mcu-eclipse/openocd/releases) page
- click **Draft a new release**
- name the tag like **v0.10.0-8-20180512** (mind the dash in the middle!)
- name the release like **GNU MCU Eclipse OpenOCD v0.10.0-8-20180512**
(mind the dash and the space)
- as description
- add a downloads badge like `[![Github Releases (by Release)](https://img.shields.io/github/downloads/gnu-mcu-eclipse/openocd/v0.10.0-8-20180512/total.svg)]()`; use empty URL for now
- copy the first paragraph from the Web release page
- add a link to the Web page `[Continue reading »]()`; use an empty URL for now
- get URL from web and update the above links
- **attach binaries** and SHA (drag and drop from the archives folder will do it)
- click the **Publish Release** button

Note: at this moment the system should send a notification to all clients watching this project.

## Update the web link

In the web git:

- `download_url: https://github.com/gnu-mcu-eclipse/openocd/releases/tag/v0.10.0-8-20180512`
- use something like `v0.10.0-8 update link` as message

## Create the xPack release

Follow the instructions on the
[openocd-xpack](https://github.com/gnu-mcu-eclipse/openocd-xpack/blob/xpack/README.md#maintainer-info)
page.

## Update the release with xPack easy install
## Create a final GitHub release

- copy the **Easy install** section from a previous release
- update release number
- go to the [GitHub Releases](https://github.com/gnu-mcu-eclipse/openocd/releases) page
- update the link behind the badge with the blog URL
- add a link to the Web page `[Continue reading »]()`; use an same blog URL
- copy/paste the **Easy install** section
- update the current release version
- copy/paste the **Download analytics** section
- update the current release version
- **disable** the **pre-release** button
- click the **Update Release** button

## Share on Facebook

Expand All @@ -128,6 +139,15 @@ page.
- click **Post to Facebook**
- check the post in the [Facebook page](https://www.facebook.com/gnu-mcu-eclipse)

## Share on Twitter

* go to the new post and follow the Tweet link
* copy the content to the clipboard
* DO NOT click the Tweet button here, it'll not use the right account
* in a separate browser windows, open [TweetDeck](https://tweetdeck.twitter.com/)
* using the `@gnu_mcu_eclipse` account, paste the content
* click the Tweet button

## Links

- [Submitting patches to the OpenOCD Gerrit server](http://openocd.org/doc-release/doxygen/patchguide.html)

0 comments on commit 20b0eca

Please sign in to comment.