OrgZephyr/west
OrgZephyr
/
west
mirror of https://github.com/zephyrproject-rtos/west.git
1
0
Fork 0
Code Issues Releases Wiki Activity
west/MAINTAINERS.rst

103 lines
3.2 KiB
ReStructuredText
Raw Normal View History

Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
Notes for maintainers cutting a release.
Pre-release test plan
---------------------
1. Make tox happy on the following first-party platforms:
- Windows 10
- the latest macOS
- the latest Ubuntu LTS
2. Make tox happy on other popular Linux distributions as resources allow.
Doing this in a container is fine.
- Arch
- the latest Ubuntu release (if different than the latest LTS)
- Debian stable (if its Python 3 is still supported)
- Debian testing
MAINTAINERS.rst: updates following 0.7.3 Minor tweaks from testing the 0.7.3 release: - mention Fedora as a Linux distro as as I've received reports of active west users on that distro - update board name for nrf52 board Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-08-05 03:59:11 +08:00
- Fedora
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
3. Build alpha N (N=1 to start, then N=2 if you need more commits, etc.) and
upload to pypi.
Make sure to check if west.manifest.SCHEMA_VERSION also needs an update
before uploading. ::
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
git clean -ffdx
WEST_VERSION=X.YaN python3 setup.py sdist bdist_wheel
twine upload -u zephyr-project dist/*
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
4. Install the alpha on test platforms. ::
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
pip3 install west==X.YaN
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
5. Create and update a default (Zephyr) workspace on all of the platforms from
1., using the installed alpha::
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
west init zephyrproject
cd zephyrproject
west update
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
6. Do the following Zephyr specific testing in the Zephyr workspace on all of
the platforms from 1. Skip QEMU tests on non-Linux platforms, and make sure
ZEPHYR_BASE is unset in the calling environment. ::
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
west build -b qemu_x86 -s zephyr/samples/hello_world -d build-qemu-x86
west build -d build-qemu-x86 -t run
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
west build -b qemu_cortex_m3 -s zephyr/samples/hello_world -d build-qemu-m3
west build -d build-qemu-m3 -t run
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
# This example uses a Nordic board. Do this for as many boards
# as you have access to / volunteers for.
MAINTAINERS.rst: updates following 0.7.3 Minor tweaks from testing the 0.7.3 release: - mention Fedora as a Linux distro as as I've received reports of active west users on that distro - update board name for nrf52 board Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-08-05 03:59:11 +08:00
west build -b nrf52dk_nrf52832 -s zephyr/samples/hello_world -d build-nrf52
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
west flash -d build-nrf52
west debug -d build-nrf52
west debugserver -d build-nrf52
west attach -d build-nrf52
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
(It's still a pass if ``west build`` requires ``--pristine``.)
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
7. Assuming that all went well (if it didn't, go fix it and repeat),
get the version bump committed, either to master or the release branch as
appropriate. See below for release branch information.
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
For the first release (e.g. vX.Y.0), master should point to the release
branch commit. Thereafter, the release branch is allowed to fork from master
to just take bugfixes etc.
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
MAINTAINERS.rst: add note for starting next version We need a .99 patchlevel during development. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-03-07 03:17:00 +08:00
8. Push a commit to master updating version.py to vX.Y.99, kicking off
development for the next release.
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
Building and uploading the release wheels
-----------------------------------------
You need the zephyr-project PyPI credentials for the 'twine upload' command. ::
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
git clean -ffdx
python3 setup.py sdist bdist_wheel
twine upload -u zephyr-project dist/*
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
The 'git clean' step is important. We've anecdotally observed broken wheels
being generated from dirty repositories.
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
Tagging the release
-------------------
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
Create and push a GPG signed tag. ::
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
git tag -a -s vX.Y.Z -m 'West vX.Y.Z
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
Signed-off-by: Your Name <your.name@example.com>'
MAINTAINERS.rst: make copy pasting commands easier Remove the $ prefixes so the commands can just be copy pasted line by line during testing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-27 03:21:43 +08:00
git push origin vX.Y.Z
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
Add MAINTAINERS.rst This is where we'll put notes for west maintainers. For now, it includes information on cutting a release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-10 23:41:44 +08:00
Cut a release branch
--------------------
MAINTAINERS.rst: some changes from going through this once A few process changes from doing a point release, mainly that we'll cut an alpha release instead of an RC. That's being done because uploading an alpha is something a maintainer can just do, without having to go through the usual "bump version.py" review process. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-24 07:30:12 +08:00
If you've cut a new minor version (vX.Y.0), also cut a release branch,
vX.Y-branch. Subsequent fixes for versions vX.Y.Z should go to that branch
after being backported from master (or the other way around in case of an
urgent hotfix).