-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e8aba0b
commit f44f339
Showing
2 changed files
with
47 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Contributing | ||
|
||
## Development | ||
|
||
```console | ||
mkdir extensions | ||
go run ./cmd/marketplace/main.go server [flags] | ||
``` | ||
|
||
When you make a change that affects people deploying the marketplace please | ||
update the changelog as part of your PR. | ||
|
||
You can use `make gen` to generate a mock `extensions` directory for testing and | ||
`make upload` to upload them to an Artifactory repository. | ||
|
||
## Tests | ||
|
||
To run the tests: | ||
|
||
``` | ||
make test | ||
``` | ||
|
||
To run the Artifactory tests against a real repository instead of a mock: | ||
|
||
``` | ||
export ARTIFACTORY_URI=myuri | ||
export ARTIFACTORY_REPO=myrepo | ||
export ARTIFACTORY_TOKEN=mytoken | ||
make test | ||
``` | ||
|
||
See the readme for using the marketplace with code-server. | ||
|
||
When testing with code-server you may run into issues with content security | ||
policy if the marketplace runs on a different domain over HTTP; in this case you | ||
will need to disable content security policy in your browser or manually edit | ||
the policy in code-server's source. | ||
|
||
## Releasing | ||
|
||
1. Check that the changelog lists all the important changes. | ||
2. Update the changelog with the release date. | ||
3. Push a tag with the new version. | ||
4. Update the resulting draft release with the changelog contents. | ||
5. Publish the draft release. | ||
6. Bump the Helm chart version once the Docker images have published. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters