You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Updates and fixes in README.md
Updates and fixes in README.md
* Add link to Elliptic Research
Add link to Elliptic Research
Co-authored-by: Steve Loeppky <[email protected]>
* Add note that versioning will be refactored
Co-authored-by: Steve Loeppky <[email protected]>
* Typo fixes
Co-authored-by: Steve Loeppky <[email protected]>
* Update README.md
Co-authored-by: Steve Loeppky <[email protected]>
* Add heading for cutting releases
Add heading for cutting the different release types, so it´s easier to hyperlink to a specific section
---------
Co-authored-by: Steve Loeppky <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+49-17Lines changed: 49 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,17 +12,15 @@ To build and install libfilcrypto, its header file and pkg-config manifest, run:
12
12
make
13
13
```
14
14
15
-
To optionally authenticate with GitHub for assets download (to increase API limits)
16
-
set `GITHUB_TOKEN` to personal access token.
15
+
To optionally authenticate with GitHub for assets download (to increase API limits) set `GITHUB_TOKEN` to personal access token.
17
16
18
-
If no precompiled static library is available for your operating system, the
19
-
build tooling will attempt to compile a static library from local Rust sources.
17
+
If no precompiled static library is available for your operating system, the build tooling will attempt to compile a static library from local Rust sources.
20
18
21
19
### Installation notes
22
20
23
-
By default, building this will download a pre-built binary of the ffi. The advantages for downloading it are faster build times, and not requiring a rust toolchain and build environment.
21
+
By default, building this will download a pre-built binary of the ffi. The advantages for downloading it are faster build times, and not requiring a rust toolchain and build environment.
24
22
25
-
The disadvantage to downloading the pre-built binary is that it will not be optimized for your specific hardware. This means that if raw performance is of utmost importance to you, it's highly recommended that you build from source.
23
+
The disadvantage to downloading the pre-built binary is that it will not be optimized for your specific hardware. This means that if raw performance is of utmost importance to you, it's highly recommended that you build from source.
26
24
27
25
### Building from Source
28
26
@@ -36,7 +34,7 @@ rm .install-filcrypto \
36
34
; FFI_BUILD_FROM_SOURCE=1 FFI_USE_BLST_PORTABLE=1 make
37
35
```
38
36
39
-
By default, a 'gpu' option is used in the proofs library. This feature is also used in FFI unless explicitly disabled. To disable building with the 'gpu' dependency, set `FFI_USE_GPU=0`:
37
+
By default, a 'gpu' option is used in the proofs library. This feature is also used in FFI unless explicitly disabled. To disable building with the 'gpu' dependency, set `FFI_USE_GPU=0`:
40
38
41
39
```shell
42
40
rm .install-filcrypto \
@@ -46,7 +44,7 @@ rm .install-filcrypto \
46
44
47
45
#### GPU support
48
46
49
-
CUDA for GPU support is now enabled by default in the proofs library. This feature can optionally be replaced by OpenCL by using `FFI_USE_OPENCL=1` set in the environment when building from source. Alternatively, if the CUDA toolkit (such as `nvcc`) cannot be located in the environment, OpenCL support is used instead. To disable GPU support entirely, set `FFI_USE_GPU=0` in the environment when building from source.
47
+
CUDA for GPU support is now enabled by default in the proofs library. This feature can optionally be replaced by OpenCL by using `FFI_USE_OPENCL=1` set in the environment when building from source. Alternatively, if the CUDA toolkit (such as `nvcc`) cannot be located in the environment, OpenCL support is used instead. To disable GPU support entirely, set `FFI_USE_GPU=0` in the environment when building from source.
50
48
51
49
There is experimental support for faster C2 named "SupraSeal". To enable it, set `FFI_USE_CUDA_SUPRASEAL=1`. It's specific to CUDA and won't work with OpenCL.
52
50
@@ -56,7 +54,7 @@ rm .install-filcrypto \
56
54
; FFI_BUILD_FROM_SOURCE=1 make
57
55
```
58
56
59
-
By default, a 'multicore-sdr' option is used in the proofs library. This feature is also used in FFI unless explicitly disabled. To disable building with the 'multicore-sdr' dependency, set `FFI_USE_MULTICORE_SDR=0`:
57
+
By default, a 'multicore-sdr' option is used in the proofs library. This feature is also used in FFI unless explicitly disabled. To disable building with the 'multicore-sdr' dependency, set `FFI_USE_MULTICORE_SDR=0`:
Maintainers are not only the contributors of this repository, but also exercise a range of editorial responsibilities to keep the repository organized for the OSS contributors, that includes triage the issues, review and merge/close PRs, publish releases and so on.
111
107
@@ -122,21 +118,57 @@ To start a CI job to build binaries off of a commit push a tag starting with the
122
118
We will cooperates with the [lotus' releases and it's testing flows](https://github.com/filecoin-project/lotus/blob/0c91b0dc1012c3e54b305a76bb25fb68390adf9d/LOTUS_RELEASE_FLOW.md?plain=1#L50) to confirm whether a tagged release is production ready:
123
119
124
120
*Non-consensus breaking changes*
125
-
- All PRs introduce non-consensus breaking changes can be merged to master as long they have maintainers' approvals.
121
+
- All PRs introducing non-consensus breaking changes can be merged to master as long they have maintainers' approvals.
126
122
- Roughly on a monthly basis, lotus will integrate ffi's head in `master` branch, for it's new feature release, and carry it through the testing flows.
127
123
-`release/lotus-vX` will be created to determine the commit that lotus integrates in the corresponding release.
128
124
- If any bug is found during the testing, the fix should land in master then get backported to `release/lotus-vX`. The updated commit should be integrated into lotus and getting tested. Repeat the steps until it can be considered as stable.
129
125
130
-
#Consensus breaking changes*
126
+
*Consensus breaking changes*
131
127
- Consensus breaking changes should be developed in it's own branch, (branch name is suggested to be: feature branches `feat/` or bug fix branches `bug/`).
132
128
- Consensus breaking changes that are scoped into the next immediate network upgrade shall land in `next` branch first. The maintainers are responsible to coordinate on when to land `next` to `master` according to lotus mandatory(network upgrade) release schedules.
133
129
- A new dev branch should be created and contributors are responsible to rebase the branch onto `master`/`next` as needed.
134
130
131
+
#### Versioning
135
132
133
+
The versioning in Filecoin-FFI currently follows the Lotus versioning. For example, if you are cutting a release for Lotus v1.28.0-rc1, the Filecoin-FFI release will be named v1.28.0-rc1 as well. (Note: Lotus versioning will be refactored in the near future as part of [lotus #12072](https://github.com/filecoin-project/lotus/issues/12072).)
134
+
135
+
#### Release Process
136
+
137
+
##### Cutting a development or release candidate release
138
+
139
+
<details>
140
+
<summary>Steps to cut a development or release candidate release:</summary>
141
+
142
+
1. Go to [Filecoin-FFI Releases](https://github.com/filecoin-project/filecoin-ffi/releases).
143
+
2. Click the "Draft a new release" button in the right corner.
144
+
3. In the "Choose a tag" dropdown, enter the desired version and click "Create new tag: vX.XX.X-rcX/dev on publish".
145
+
4. Target the master branch.
146
+
5. Set the previous tag to compare against, which should be the last stable release.
147
+
6. Click the "Generate release notes" button.
148
+
6. Check the "Set as a pre-release" checkbox.
149
+
7. Click "Publish release" to create the release.
150
+
151
+
</details>
152
+
153
+
##### Cutting a definitive release
154
+
155
+
<details>
156
+
<summary>Steps to cut a definitive release:</summary>
157
+
158
+
1. Go to [Filecoin-FFI Releases](https://github.com/filecoin-project/filecoin-ffi/releases).
159
+
2. Click the "Draft a new release" button in the right corner.
160
+
3. In the "Choose a tag" dropdown, enter the desired version and click "Create new tag: vX.XX.X on publish".
161
+
4. Target the release candidate you want to create a stable.
162
+
5. Set the previous tag to compare against, which should be the last stable release (e.g., non-RC)
163
+
6. click the "Generate release notes" button.
164
+
6. Ensure the "Set as a latest release" checkbox **is checked**.
165
+
7. Click "Publish release" to create the release.
166
+
167
+
</details>
136
168
137
169
## License
138
170
139
-
MIT or Apache 2.0
171
+
This repository is dual-licensed under Apache 2.0 and MIT terms.
0 commit comments