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

Add some details about release process. [skip-ci] #136

Merged
merged 3 commits into from
Feb 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ this same document.
- `misc/`: for anything else (like adding docs, READMEs, etc.).
- We open a *pull request* when we think the branch should be merged. **Becareful: when opening
the pull request, select `develop` as base branch!**
- Do not forget to update the CHANGELOG.md **before** opening a pull request.
- We review the *pull request*. We don’t set a fixed number of reviewers, but don’t forget the
golden rule: the more people review, the better.
- If your change impacts no path from the CI (for instance, you just added a new tool or fixed a
Expand All @@ -32,10 +33,29 @@ this same document.
to your changes.
- Do the same thing in [appveyor.yml] for the `LIB_VERSION` key.
- [We appologize for not having automated that yet.](#117)
- Do not forget to bump the version, if needed, **before** opening a pull request
- We *tag* stable releases on `master` with [SemVer].
- We *tag* instable releases on `develop` with the special `-rc` suffix to support *release
candidates*.

## Release process
- Development: fixes, features are done on specific branches on developers' fork,
- Pull requests: submitted to LedgerHQ/develop with updated CHANGELOG.md,
- Merge into `LedgerHQ/develop`: triggers CI builds and deploys under `x.y.z-rc-commitHash`,
- Merge into `LedgerHQ/master`: once a version is confirmed to be stable at least by one of our clients
(Vault or Live), we bump project’s version, for this we have a special pull request. Once merged in
`LedgerHQ/master` and tagged as a stable release `x.y.z`, a build and a deployment are triggered.
To sum up, tags point to stable releases that are in production. **These versions should be used by any application
client of libcore**
- Patches: only applied on previously affected releases that has been in production, to apply a patch to a version `x.y.z`,
we create a branch from master at `x.y.z` tag, push all fixes to it, once stable (confirmed by client)
we tag a new patched stable release (e.g. `x.y.(z+1)`). Then this branch is merged to `LedgerHQ/develop`.
Each 3/4 weeks we clean upstream from unused branches.

<p align="center">
<img src="/ressources/patch.png" width="550"/>
</p>

## About coin integration

We might accept coin integration at some day but currently, **we do not accept pull-requests that add
Expand Down
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,20 @@ Generating bindings is a several steps process:
```
node ledger-core-samples/nodejs/tests/wallet-pool-test.js
```

## Support

### Libcore:
Libcore can be built for following OSes:
- MacOS: minimum supported version is `macOS 9.0`, with `x86_64` architecture,
- Linux: Debian (stretch), Ubuntu and Arch are supported, with `x86_64` architecture,
- Windows: 64-bit architecture is built with `MSVC` (starting from Visual Studio 15), 32-bit is built with `MinGW`,
- iOS: `x86_64`, `armv7` and `arm64` architectures are supported, minimum supported version is `iOS 10.0`,
- Android: `x86`, `armeabi-v7a` and `arm64-v8a` architectures are supported, minimum supported version is `Android 7 (API 24)` (Java 8 is needed).
### Bindings:
- NodeJS bindings:
- Please use `node` with version `>=8.4.0` and `<9.0.0` (other versions are not tested (yet)),
- Node-gyp is used to build native module and requires `python` with version `2.7.x`.

## Developement guidelines

### CI
Expand Down
2 changes: 1 addition & 1 deletion djinni
Binary file added ressources/patch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.