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
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+6-21
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,6 @@ make build
20
20
21
21
After building the project, you can run the main binary that is produced.
22
22
23
-
24
23
```bash
25
24
make start
26
25
```
@@ -29,7 +28,6 @@ make start
29
28
30
29
You can run the test compiled executable:
31
30
32
-
33
31
```bash
34
32
make test
35
33
```
@@ -38,7 +36,6 @@ make test
38
36
39
37
Documentation for the libraries in the project can be generated with:
40
38
41
-
42
39
```bash
43
40
make doc
44
41
open-cli $(make doc-path)
@@ -50,30 +47,18 @@ This assumes you have a command like [open-cli](https://github.com/sindresorhus/
50
47
51
48
### Releasing
52
49
53
-
To release prebuilt binaries to all platforms, we use Github Actions to build each binary individually.
50
+
To release prebuilt binaries to all platforms, we use GitHub Actions to build each binary individually.
54
51
55
-
The binaries are then uploaded to a Github Release and NPM automatically.
52
+
The binaries are then uploaded to a GitHub Release.
56
53
57
54
To trigger the Release workflow, you need to push a git tag to the repository.
58
-
We provide a script that will bump the version of the project, tag the commit and push it to Github:
55
+
We provide a script that will bump the version of the project, tag the commit and push it to GitHub:
59
56
60
57
```bash
61
-
./script/release.sh
58
+
make release
62
59
```
63
60
64
-
The script will release the current project version on Opam, update the documentation and push a new tag on Github.
65
-
66
-
### Releasing
67
-
68
-
To create a release and publish it on Opam, first update the `CHANGES.md` file with the last changes and the version that you want to release.
69
-
The, you can run the script `script/release.sh`. The script will perform the following actions:
70
-
71
-
- Create a tag with the version found in `spin.opam`, and push it to your repository.
72
-
- Create the distribution archive.
73
-
- Publish the distribution archive to a Github Release.
74
-
- Submit a PR on Opam's repository.
75
-
76
-
When the release is published on Github, the CI/CD will trigger the `Release` workflow which will compile binaries for all supported platforms and add them to the Github Release as assets.
61
+
The script will release the current project version on Opam, update the documentation and push a new tag on GitHub.
77
62
78
63
### Repository Structure
79
64
@@ -82,7 +67,7 @@ The following snippet describes Spin's repository structure.
82
67
```text
83
68
.
84
69
├── .github/
85
-
| Contains Github specific files such as actions definitions and issue templates.
70
+
| Contains GitHub specific files such as actions definitions and issue templates.
86
71
│
87
72
├── bin/
88
73
| Source for Spin's binary. This links to the library defined in `lib/`.
0 commit comments