Skip to content

Commit 96bebed

Browse files
committed
docs: add contribution guide
1 parent 829e54b commit 96bebed

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTION.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Update the Feature
2+
3+
The main logic of the kusion feature is in following files:
4+
- src/kusion/devcontainer-feature.json: the metadata of the feature, for example the id, version, parameters, env, dependent extensions...
5+
- src/kusion/install.sh: the install script to install kusion and kclvm to the container.
6+
7+
### Update the Sources
8+
We could update these two files to upgrade kusion versions, parameters, etc.
9+
10+
### Update The Tests
11+
And after updated the feature, remember to update the tests in `test/_global` and `test/kusion`
12+
13+
### Push and Trigger CI
14+
Pushing the updates to the repository will trigger a [CI pipeline](https://github.com/KusionStack/devcontainer-features/actions/workflows/test.yaml), please make sure to paas the tests.
15+
16+
## Release the Feature
17+
18+
### Trigger Release Action
19+
20+
To release the feature to the latest version, manually trigger the 'Release dev container features & Generate Documentation' task in the [Github Workflows](https://github.com/KusionStack/devcontainer-features/actions/workflows/release.yaml).
21+
22+
### Make Sure the Package Is Released
23+
24+
After the release pipeline succeeded, the version of the feature packages should be updated to the released version. Check (here)[https://github.com/KusionStack/devcontainer-features/pkgs/container/devcontainer-features%2Fkusion] to make sure the kusion feature package version is updated.
25+
26+
### Trigger the PreBuild If Needed
27+
28+
Then after releasement, We can manually trigger a prebuild task in the repository which adopted the feature in its [codespaces settings page](https://github.com/${user}/${repo}/settings/codespaces).

0 commit comments

Comments
 (0)