Skip to content

Commit 4a04911

Browse files
committed
Add development flows page
1 parent b8e02ed commit 4a04911

File tree

7 files changed

+86
-1
lines changed

7 files changed

+86
-1
lines changed

home/.vitepress/config.mts

+2-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ export default defineConfig({
8080
text: 'For Developers',
8181
items: [
8282
{text: 'Building', link: 'docs/building'},
83-
{text: 'Contribution guidelines', link: 'docs/contrib'}
83+
{text: 'Contribution guidelines', link: 'docs/contrib'},
84+
{text: 'Development flows', link: 'docs/development-flows'}
8485
]
8586
},
8687
{

home/docs/development-flows.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Development Flows | Collapse Launcher
3+
---
4+
5+
# Development Flows
6+
Any software development needs a certain flows on actions to do on each commits and releases. This section will explain how Collapse project handle commits and release publishing flows.
7+
8+
::: tip
9+
If the images are too small to see, click on them to zoom.
10+
:::
11+
12+
## Code Submission Flow
13+
14+
<figure style="text-align: center">
15+
<a>
16+
<img src='/img/docs/Collapse-gitScheme.svg' title="Collapse code repository scheme" alt="Collapse code repository scheme" loading="lazy" style="display: block; margin: 0 auto;" width="auto" data-zoomable>
17+
</a>
18+
</figure>
19+
20+
::: info
21+
* Code quality scan (Qodana) on main branch runs every Sunday, Wednesday, and Friday
22+
* Qodana scan runs on every Feature/Fix Pull Requests with comment alerts
23+
* All submitted commits are scanned for vulnerability (Snyk) and Licence Compliance (FOSSA)
24+
* Main branch is locked for "Force Push"
25+
* Stable branch might get force pushed on what we called "Stable sync" where Stable branch gets matched with Main branch until the next major/minor Preview release
26+
:::
27+
28+
## Release Publication Flow
29+
30+
<figure style="text-align: center">
31+
<a>
32+
<img src='/img/docs/Collapse-appPublication.svg' title="Collapse code repository scheme" alt="Collapse code repository scheme" loading="lazy" style="display: block; margin: 0 auto;" width="auto" data-zoomable>
33+
</a>
34+
</figure>
35+
36+
::: info
37+
* Available CDNs:
38+
1. GitHub (Main)
39+
2. Cloudflare (Cloudfare R2, Southeast Asia region)
40+
3. GitLab
41+
4. CODING (Mainland China)
42+
* App Packer script can be inspected in [our release repository](https://github.com/CollapseLauncher/CollapseLauncher-ReleaseRepo/blob/main/pack_signed_velopack.bat)
43+
* Both Portable and Installer artifacts will be uploaded to [main repository 'Releases' section](https://github.com/CollapseLauncher/Collapse/releases)
44+
:::
45+
46+
<script setup>
47+
import { onMounted } from 'vue';
48+
import mediumZoom from 'medium-zoom';
49+
50+
onMounted(() => {
51+
const backgroundColor = getComputedStyle(document.documentElement).getPropertyValue('--vp-c-bg').trim();
52+
mediumZoom('[data-zoomable]', { background: backgroundColor || '#fff' });
53+
});
54+
</script>
55+
56+
<style>
57+
.medium-zoom-overlay {
58+
z-index: 10000 !important;
59+
background: var(--vp-c-bg) !important;
60+
}
61+
.medium-zoom-image--opened {
62+
z-index: 10001 !important;
63+
}
64+
</style>

home/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ features:
4848
details: Up to 10X less update download size for certain region by utilizing HDiffZ folder comparison method.
4949
link: feature/delta-patch
5050
linkText: Learn more
51+
- title: Code you can Trust
52+
details: All published binaries goes through many verification steps and code-signed (courtesy of SignPath) before being published to users
53+
linkText: Learn more
54+
link: docs/development-flows
55+
5156
---
5257
<script setup>
5358
import './index.css'

home/public/img/docs/Collapse-appPublication.svg

+4
Loading

home/public/img/docs/Collapse-gitScheme.svg

+4
Loading

package-lock.json

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"home:preview": "vitepress preview home"
66
},
77
"dependencies": {
8+
"medium-zoom": "^1.1.0",
89
"vitepress": "^1.5.0",
910
"vue": "^3.5.13"
1011
}

0 commit comments

Comments
 (0)