-
Notifications
You must be signed in to change notification settings - Fork 5.3k
fix: release sdks doc #10817
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
fix: release sdks doc #10817
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -26,27 +26,34 @@ Before releasing SDKs, you need to: | |
|
|
||
| To enable SDK releases via GitHub, you need to mount SSH keys and configure GitHub authentication in your Docker environment. | ||
|
|
||
| #### Update docker-compose.override.yml | ||
| #### Update Dockerfile | ||
|
|
||
| Update `docker-compose.override.yml` to mount SSH keys and set environment variables for the `appwrite` service: | ||
| Add the following configuration to your `Dockerfile`: | ||
|
|
||
| ```dockerfile | ||
| ARG GH_TOKEN | ||
| ENV GH_TOKEN=your_github_token_here | ||
| RUN git config --global user.email "[email protected]" | ||
| RUN apk add --update --no-cache openssh-client github-cli | ||
| ``` | ||
|
|
||
| Replace: | ||
| - `your_github_token_here` with your GitHub personal access token (with appropriate permissions) | ||
| - `[email protected]` with your Git email address | ||
|
|
||
| #### Update docker-compose.yml | ||
|
|
||
| Add the SSH key volume mount to the `appwrite` service in `docker-compose.yml`: | ||
|
|
||
| ```yaml | ||
| services: | ||
| appwrite: | ||
| volumes: | ||
| - ~/.ssh:/root/.ssh | ||
| environment: | ||
| - GH_TOKEN=your_github_token_here | ||
| - [email protected] | ||
| # ... other volumes | ||
| ``` | ||
|
ChiragAgg5k marked this conversation as resolved.
|
||
|
|
||
| Uncomment the volumes section. | ||
|
|
||
| Replace: | ||
| - `your_github_token_here` with your GitHub personal access token (with appropriate permissions) | ||
| - `[email protected]` with your Git email address | ||
|
|
||
| This mounts your SSH keys from the host machine and sets the GitHub token and email as environment variables, allowing the container to authenticate with GitHub. The git configuration is handled automatically at runtime. | ||
| This mounts your SSH keys from the host machine, allowing the container to authenticate with GitHub. | ||
|
ChiragAgg5k marked this conversation as resolved.
|
||
|
|
||
| ### Updating Specs | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.