aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github
diff options
context:
space:
mode:
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md22
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml6
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md18
-rw-r--r--.github/workflows/stats.yml18
-rw-r--r--.github/workflows/test.yml2
5 files changed, 39 insertions, 27 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 7c480c52f..47129ea74 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -18,8 +18,10 @@ Interested in contributing? Awesome!
18 - [Server side](#server-side) 18 - [Server side](#server-side)
19 - [Client side](#client-side) 19 - [Client side](#client-side)
20 - [Client and server side](#client-and-server-side) 20 - [Client and server side](#client-and-server-side)
21 - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) 21 - [RTL layout](#rtl-layout)
22 - [Unit tests](#unit-tests) 22 - [Testing](#testing)
23 - [Unit tests](#unit-tests)
24 - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
23 - [Emails](#emails) 25 - [Emails](#emails)
24- [Plugins & Themes](#plugins--themes) 26- [Plugins & Themes](#plugins--themes)
25 27
@@ -163,6 +165,14 @@ and the web server is automatically restarted.
163$ npm run dev 165$ npm run dev
164``` 166```
165 167
168### RTL layout
169
170To test RTL layout using `ar` locale:
171
172```
173$ npm run dev -- --ar-locale
174```
175
166### Testing 176### Testing
167 177
168Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves 178Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves
@@ -216,14 +226,16 @@ $ createdb -O peertube peertube_test{1,2,3}
216Build the application and flush the old tests data: 226Build the application and flush the old tests data:
217 227
218``` 228```
219$ npm run build -- --light 229$ npm run build
220$ npm run clean:server:test 230$ npm run clean:server:test
221``` 231```
222 232
223This will run 3 nodes: 233To run 3 nodes:
224 234
225``` 235```
226$ npm run play 236$ NODE_APP_INSTANCE=1 NODE_ENV=test npm start
237$ NODE_APP_INSTANCE=2 NODE_ENV=test npm start
238$ NODE_APP_INSTANCE=3 NODE_ENV=test npm start
227``` 239```
228 240
229Then you will get access to the three nodes at `http://localhost:900{1,2,3}` 241Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 42096433b..2911f6202 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,11 +1,11 @@
1blank_issues_enabled: false 1blank_issues_enabled: false
2contact_links: 2contact_links:
3 - name: 💬 IRC
4 url: https://kiwiirc.com/client/irc.freenode.net/#peertube
5 about: Chat with us via IRC for quick Q/A here
6 - name: 💬 Matrix 3 - name: 💬 Matrix
7 url: https://matrix.to/#/#peertube:matrix.org 4 url: https://matrix.to/#/#peertube:matrix.org
8 about: Chat with us via Matrix for quick Q/A here 5 about: Chat with us via Matrix for quick Q/A here
6 - name: 💬 IRC
7 url: https://web.libera.chat/#peertube
8 about: Chat with us via IRC for quick Q/A here
9 - name: 🤷💻🤦 Forum 9 - name: 🤷💻🤦 Forum
10 url: https://framacolibri.org/c/peertube 10 url: https://framacolibri.org/c/peertube
11 about: You can ask and answer other questions here 11 about: You can ask and answer other questions here
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index a49db848f..abc25477f 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,24 +6,16 @@
6 6
7<!-- If suggesting a new feature or change, please discuss it in an issue first --> 7<!-- If suggesting a new feature or change, please discuss it in an issue first -->
8<!-- If fixing a bug, there should be an issue describing it with steps to reproduce --> 8<!-- If fixing a bug, there should be an issue describing it with steps to reproduce -->
9<!-- start with closing keywords if any apply: https://docs.github.com/en/enterprise/2.16/user/github/managing-your-work-on-github/closing-issues-using-keywords -->
10 9
11## Has this been tested? 10## Has this been tested?
12 11
13<!--- Put an `x` in the box that applies: --> 12<!-- Put an `x` in the box that applies: -->
13<!-- Check the unit test guide: https://docs.joinpeertube.org/contribute-getting-started?id=unit-tests -->
14
14- [ ] 👍 yes, I added tests to the test suite 15- [ ] 👍 yes, I added tests to the test suite
15- [ ] 👍 yes, light tests as follows are enough
16- [ ] 💭 no, because this PR is a draft and still needs work 16- [ ] 💭 no, because this PR is a draft and still needs work
17- [ ] 🙅 no, because they aren't needed 17- [ ] 🙅 no, because this PR does not update server code
18- [ ] 🙋 no, because I need help 18- [ ] 🙋 no, because I need help <!-- Detail how we can help you -->
19
20<!--
21If you didn't test via unit-testing, you will still be asked to prove your fix is effective, doesn't have side-effects, or that your feature simply works:
22
23Please describe the tests that you ran to verify your changes.
24Provide instructions so we can reproduce.
25Please also list any relevant details for your test configuration(s):
26-->
27 19
28## Screenshots 20## Screenshots
29 21
diff --git a/.github/workflows/stats.yml b/.github/workflows/stats.yml
index a2f0945b3..968eb9612 100644
--- a/.github/workflows/stats.yml
+++ b/.github/workflows/stats.yml
@@ -45,23 +45,31 @@ jobs:
45 branch-base: develop 45 branch-base: develop
46 bundlewatch-github-token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }} 46 bundlewatch-github-token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
47 47
48 - name: PeerTube code stats
49 if: github.event_name != 'pull_request'
50 run: |
51 wget "https://github.com/boyter/scc/releases/download/v3.0.0/scc-3.0.0-x86_64-unknown-linux.zip"
52 unzip "scc-3.0.0-x86_64-unknown-linux.zip"
53 ./scc --format=json --exclude-dir .git,node_modules,client/node_modules,client/dist,dist,yarn.lock,client/yarn.lock,client/src/locale,test1,test2,test3,client/src/assets/images,config,storage,server/tests/fixtures,support/openapi,.idea,.vscode,docker-volume,ffmpeg-3,ffmpeg-4 > ./scc.json
54
48 - name: PeerTube client stats 55 - name: PeerTube client stats
49 if: github.event_name != 'pull_request' 56 if: github.event_name != 'pull_request'
50 run: | 57 run: |
51 node dist/scripts/client-build-stats.js > client-build-stats.json 58 node dist/scripts/client-build-stats.js > client-build-stats.json
52 59
53 - name: PeerTube code stats 60 - name: PeerTube client lighthouse report
54 if: github.event_name != 'pull_request' 61 if: github.event_name != 'pull_request'
55 run: | 62 run: |
56 wget "https://github.com/boyter/scc/releases/download/v3.0.0/scc-3.0.0-x86_64-unknown-linux.zip" 63 sudo apt-get install chromium-browser
57 unzip "scc-3.0.0-x86_64-unknown-linux.zip" 64 sudo npm install -g lighthouse
58 ./scc --format=json --exclude-dir .git,node_modules,client/node_modules,client/dist,dist,yarn.lock,client/yarn.lock,client/src/locale,test1,test2,test3,client/src/assets/images,config,storage,server/tests/fixtures,support/openapi,.idea,.vscode,docker-volume,ffmpeg-3,ffmpeg-4 > ./scc.json 65 lighthouse --chrome-flags="--headless" https://peertube2.cpy.re --output=json --output-path=./lighthouse.json
59 66
60 - name: Display stats 67 - name: Display stats
61 if: github.event_name != 'pull_request' 68 if: github.event_name != 'pull_request'
62 run: | 69 run: |
63 cat client-build-stats.json 70 cat client-build-stats.json
64 cat scc.json 71 cat scc.json
72 cat lighthouse.json
65 73
66 - name: Upload stats 74 - name: Upload stats
67 if: github.event_name != 'pull_request' 75 if: github.event_name != 'pull_request'
@@ -87,5 +95,5 @@ jobs:
87 95
88 if [ ! -z ${STATS_DEPLOYEMENT_KEY+x} ]; then 96 if [ ! -z ${STATS_DEPLOYEMENT_KEY+x} ]; then
89 echo "Uploading files" 97 echo "Uploading files"
90 scp client-build-stats.json scc.json ${STATS_DEPLOYEMENT_USER}@${STATS_DEPLOYEMENT_HOST}:../../web/peertube-stats; 98 scp lighthouse.json client-build-stats.json scc.json ${STATS_DEPLOYEMENT_USER}@${STATS_DEPLOYEMENT_HOST}:../../web/peertube-stats;
91 fi 99 fi
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index a1edde1ef..46b243244 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -39,7 +39,7 @@ jobs:
39 strategy: 39 strategy:
40 fail-fast: false 40 fail-fast: false
41 matrix: 41 matrix:
42 test_suite: [ misc, api-1, api-2, api-3, api-4, cli, lint, external-plugins ] 42 test_suite: [ client, api-1, api-2, api-3, api-4, cli-plugin, lint, external-plugins ]
43 43
44 env: 44 env:
45 PGUSER: peertube 45 PGUSER: peertube