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: .github/workflows/README.md
+8-2Lines changed: 8 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,15 @@
1
1
# Workflows
2
+
2
3
This page contains some documentation on the workflows for this repository.
3
4
4
5
## build_test
6
+
5
7
The workflow build_test is used to build and test the code (see build_test.yaml). Notice that the binaries are being cached so that the build process is sped up. Once the binaries are build the pipeline will run both the unit tests and the integration tests. This can take up to 30 minutes. The pipeline is ran on every commit to a PR and also when the PR has been merged with development. PRs should only be merged if the pipeline was green (if all tests passed).
6
8
7
-
For performance reasons we are using a self hosted runner for running the pipeline. The runner will only run one pipeline at a time which means that all other runs will be queued. As the pipeline is ran on every commit it will thus also queue runs of consecutive pushed commits. We strongly advice to add `[skip ci]` to the commit messages whenever possible (when the run of a pipeline can be skipped). A pipeline can also be canceled [here](https://github.com/threefoldtech/tfchain/actions).
9
+
For performance reasons we are using a self hosted runner for running the pipeline. The runner will only run one pipeline at a time which means that all other runs will be queued. As the pipeline is ran on every commit it will thus also queue runs of consecutive pushed commits. We strongly advice to add `[skip ci]` to the commit messages whenever possible (when the run of a pipeline can be skipped). A pipeline can also be canceled [here](https://github.com/threefoldtech/tfchain/actions).
8
10
9
11
### Docker image
12
+
10
13
We are using a custom docker image for building and testing the code. You can find the image on our [Docker Hub](https://hub.docker.com/repository/docker/threefolddev/tfchain). The dockerfile build_test.Dockerfile was used to build that image. If the image no longer meets the expectations please follow these steps:
11
14
12
15
1) Update the dockerfile as required (add what you need)
@@ -18,8 +21,11 @@ We are using a custom docker image for building and testing the code. You can fi
18
21
4) Upload the image (you will need the credentials):
19
22
> docker login
20
23
> docker push threefolddev/tfchain:\<VERSION>
21
-
5) Update the pipeline on the repository https://github.com/threefoldtech/tfchain under .github/workflows to use this new image
24
+
5) Update the pipeline on the repository <https://github.com/threefoldtech/tfchain> under .github/workflows to use this new image
22
25
6) Push your changes, create a PR and let the pipeline run. If it fails due to changes to the image you should start over the steps.
23
26
7) Once the PR is landed please tag the repository so that we can trace back the dockerfile given the version:
24
27
> git tag -a dockerfile-build-v\<VERSION> -m "new dockerfile version \<VERSION>"
25
28
29
+
## Publishing of a docker image
30
+
31
+
[publish_container_image.yml](./publish_container_image.yml) builds the docker container of a tfchain node and publishes it to the github container repository on a release.
0 commit comments