edgeone 1.0.14 → 1.0.16-beta.1

package/README.md

@@ -1,4 +1,3 @@
-
 <br/>
 <div align="center">
   <img src="https://cloudcache.tencent-cloud.com/qcloud/ui/static/static_source_business/8f2d5c70-8f06-4366-ae29-1a3eb9c7f602.svg" height="96">
@@ -17,12 +16,11 @@ EdgeOne CLI can help you manage and debug Pages Functions in the project more ef
 
 ## 1. Preparations
 
-
 - Quickly register and log in to the [Tencent Cloud Console](https://edgeone.ai/pages/new?s_url=https://console.tencentcloud.com/) using a Gmail account.
 
 - Create a [Pages project](https://edgeone.ai/pages/new?s_url=https://console.tencentcloud.com/edgeone/pages) in the Console, and clone the repository to Local.
 
-*If you are a China site user, please go to the corresponding [Pages](https://console.cloud.tencent.com/edgeone/pages) console.*
+_If you are a China site user, please go to the corresponding [Pages](https://console.cloud.tencent.com/edgeone/pages) console._
 
 <br />
 
@@ -31,49 +29,48 @@ EdgeOne CLI can help you manage and debug Pages Functions in the project more ef
 ### 1. Install
 
 In the cloned project during the preparation stage, you can use npm to install the CLI:
-``` plaintext
+
+```plaintext
 npm install -g edgeone
 ```
 
 Use the `edgeone -v` command to check if the installation is successful. Use the `edgeone -h` command to view all relevant commands.
 
-### 
+###
 
 ### 2. Log in
 
-Execute the login command, follow the prompts to select `Global` (International) or `China`,  then complete the login in the pop-up browser window.
-``` plaintext
+Execute the login command, follow the prompts to select `Global` (International) or `China`, then complete the login in the pop-up browser window.
+
+```plaintext
 edgeone login
 ```
 
 After completing the login, you can use the `edgeone whoami` command to view the current login account information.
 
-
-
 ### 3. Initialize
 
 After successful login, execute the initialization command to initialize the basic environment required by Edgeone Pages in the project:
-``` plaintext
+
+```plaintext
 edgeone pages init
 ```
 
 After initialization, a `functions` folder and sample functions will be generated in the root directory of the project. You can continue to add and develop functions in this folder.
 
-
-
 ### 4. Local Development
 
 After completing initialization, enter the local development stage:
-``` plaintext
+
+```plaintext
 edgeone pages dev
 ```
 
 Executing the command will start a service on the local port 8088 by default. You can access the sample function via `http://localhost:8088/helloworld`. Here, the access path is the address path of the function file in the `functions` folder.
 
-
-
 During local development, the service for Pages Functions and the service for the Pages project may run on different ports. In order to allow the Pages project to call functions, you can use a proxy server or reverse proxy to forward requests to the correct port. Here is an example configuration of webpack-dev-server:
-``` javascript
+
+```javascript
 module.exports = {
   devServer: {
     proxy: {
@@ -82,47 +79,44 @@ module.exports = {
         chagneOrigin: true,
         pathRewrite: {
           '^/api': '',
-        }
-      }
-    }
-  }
-}
+        },
+      },
+    },
+  },
+};
 ```
 
 In this way, use the Fetch API in the Pages project:
-``` javascript
+
+```javascript
 fetch('/api/my-functions', {
-    method: 'POST',
-    body: JSON.stringify({ data: 'example' }),
-})
+  method: 'POST',
+  body: JSON.stringify({ data: 'example' }),
+});
 ```
 
-
-
 ### 5. Associated Project
 
 If you need to use the Key-Value Storage capability or synchronize the environment variables set in the console to local debugging, you can execute the Associated Project commands, enter the project name as required. The project name here is the one created in the Preparation Work of the Pages project.
-``` plaintext
+
+```plaintext
 edgeone pages link
 ```
 
-
-
 ### 6. Submit for Deployment
 
 After local development and debugging are completed, push the project code to the Git remote to trigger the CI build and deployment in the Pages backend, completing the entire development process.
 
-
-
 ### 7. Switching Accounts
 
 If you need to switch to another Tencent Cloud account, you can execute the following command and then log in again:
-``` plaintext
+
+```plaintext
 edgeone switch
 ```
 
-
 ### 8. Combine with front end
+
 EdgeOne Pages CLI supports local development and debugging of EdgeOne Pages functions. If your project contains frontend code, you need to manually start the corresponding development service.
 
 For frontend applications that need to access local functions, currently you need to distinguish function access paths through environment variables in your frontend code:
@@ -135,24 +129,63 @@ ENV=dev npm run build
 const REQUEST_API = process.env.ENV === 'dev' ? 'https://localhost:8088/' : '/'
 ```
 
-
 For functions involving cross-origin validation scenarios like login and authentication, you can specify the `--fePort` parameter when starting the development server.
 
 ```
 edgeone pages dev --fePort=8000 // your front dev server port
 ```
 
+<br/>
+
+## 3. CI/CD Integration
+
+This section provides guidance on integrating EdgeOne CLI into your CI/CD pipelines for automated deployments.
+
+### Deploy Command for CI Pipelines
+
+The deploy command allows you to deploy a folder or ZIP package directly to EdgeOne Pages from your CI/CD pipeline without using Git-based deployment.
+
+```plaintext
+edgeone pages deploy <directoryOrZip> -t <token>
+```
+
+#### Parameters
+
+- `<directoryOrZip>`: Path of folder or ZIP package to deploy (required)
+- `-t, --token`: API Token for CI/CD pipelines (required for non-interactive environments)
+- `-e, --env`: Environment to deploy to, choices: 'production' or 'preview' (default: 'production')
+
+#### CI Pipeline Examples
+
+```plaintext
+# Basic CI deployment to production
+edgeone pages deploy ./dist -t $EDGEONE_API_TOKEN
+
+# CI deployment to preview environment
+edgeone pages deploy ./build.zip -e preview -t $EDGEONE_API_TOKEN
+```
+
+#### Obtaining an API Token
+
+For more information, please refer to https://edgeone.ai/document/177158578324279296'
+
+To use the deploy command in CI/CD pipelines, you need to generate an API token:
+
+1. Log in to the EdgeOne Console
+2. Navigate to the Pages project settings
+3. Generate an API token with deployment permissions
+4. Add this token as a secure environment variable in your CI/CD system
 
 <br/>
 
 ## References
+
 [Pages Introduction](https://edgeone.ai/document/160427672992178176) ｜ [Pages Functions](https://edgeone.ai/document/162227908259442688)
 
-*To access the China site documentation, please click [here](https://edgeone.cloud.tencent.com/pages/document/162936635171454976).*
+_To access the China site documentation, please click [here](https://edgeone.cloud.tencent.com/pages/document/162936635171454976)._
 
 <br/>
 
 ## Contact
-If you need technical support, please [contact us](https://edgeone.ai/contact?source=edgeone-cli).
-
 
+If you need technical support, please [contact us](https://edgeone.ai/contact?source=edgeone-cli).