Skip to content

Commit 7368bd2

Browse files
Update README.md
1 parent 86293f0 commit 7368bd2

1 file changed

Lines changed: 34 additions & 2 deletions

File tree

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# DemonZ Deployer
88

9-
**A serverless, zero-friction deployment engine to synchronize mobile development workspaces directly to GitHub.**
9+
**A serverless, zero-friction deployment engine engineered to synchronize mobile development workspaces directly to GitHub.**
1010

1111
[![Build Status](https://img.shields.io/badge/Build-Passing-brightgreen)](#)
1212
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](#)
@@ -19,7 +19,7 @@
1919

2020
## System Overview
2121

22-
Mobile development environments often generate thousands of individual files. Attempting to synchronize these local workspaces with remote version control via mobile web browsers introduces significant friction and payload limitations.
22+
Mobile development environments often generate thousands of individual files. Attempting to synchronize these local workspaces with remote version control via mobile web browsers introduces significant friction, payload limitations, and browser instability.
2323

2424
DemonZ Deployer resolves this bottleneck using a hybrid serverless architecture. Instead of uploading files individually, developers transmit a single compressed workspace binary (`workspace.zip`) via a secure, client-side interface. This action triggers an automated CI/CD pipeline that unpacks, verifies, and commits the structural changes directly to the target repository in the background.
2525

@@ -69,6 +69,38 @@ Deploying your workspace is completely frictionless. You do not need to install
6969
* Input your target repository identifier (e.g., `DemonZDevelopment/my-app`) and your Personal Access Token.
7070
* Upload your `workspace.zip` into the UI. The pipeline will automatically handle the extraction and synchronization.
7171

72+
## Access Token Generation
73+
74+
DemonZ Deployer requires a GitHub Personal Access Token (PAT) with repository write access to transmit payloads securely via the API.
75+
76+
**Generating a Fine-Grained Token (Recommended for Security):**
77+
1. Navigate to your GitHub profile settings.
78+
2. Select **Developer settings** > **Personal access tokens** > **Fine-grained tokens**.
79+
3. Click **Generate new token**.
80+
4. Assign a strict naming convention (e.g., `DemonZ-Deployer-Access`) and set an expiration date.
81+
5. Under **Repository access**, select **Only select repositories** and choose your specific target workspace.
82+
6. Under **Repository permissions**, grant **Read and write** access to **Contents**.
83+
7. Generate the token and store it securely.
84+
85+
**Generating a Classic Token:**
86+
If utilizing a Classic Token instead of Fine-Grained, ensure the overarching `repo` scope is checked during generation.
87+
88+
## Troubleshooting & Diagnostics
89+
90+
If the deployment sequence fails, consult the terminal logs in the UI and reference the solutions below.
91+
92+
**HTTP 401 / Bad Credentials:**
93+
The Personal Access Token provided is invalid, expired, or was copied incorrectly. Regenerate the token following the steps above and update your client-side credentials.
94+
95+
**HTTP 404 / Repository Not Found:**
96+
The target repository format is incorrect, or your token lacks permission to view the repository. Ensure the target format is exactly `OwnerName/RepositoryName` (e.g., `DemonZDevelopment/my-app`) and verify your token scopes.
97+
98+
**Payload Transmitted but Pipeline Fails to Trigger:**
99+
Ensure the `deployer-pipeline.yml` file is located exactly within the `.github/workflows/` directory on the default branch of your target repository. GitHub Actions will not monitor for the `workspace.zip` push event if the workflow file is misplaced.
100+
101+
**Workflow Fails During Commit Phase:**
102+
If the GitHub Action successfully extracts the payload but fails to push the new commit, the repository's bot permissions are restricted. Navigate to the target repository **Settings** > **Actions** > **General** > **Workflow permissions**, and ensure **Read and write permissions** is actively selected.
103+
72104
## Security Notice
73105

74106
This application operates exclusively as a static, client-side interface. Personal Access Tokens provided to the application are utilized strictly for authorizing requests to the official GitHub API. DemonZ Development does not collect, proxy, transmit, or store user credentials or repository telemetry.

0 commit comments

Comments
 (0)