From 6e31858354356ee09e0f51401ef3c05a921e2dc3 Mon Sep 17 00:00:00 2001 From: Shazron Abdullah Date: Thu, 21 Mar 2024 19:07:08 +0800 Subject: [PATCH 1/4] fix: add docs for `aio app pack` command --- src/pages/guides/packaging.md | 47 +++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 src/pages/guides/packaging.md diff --git a/src/pages/guides/packaging.md b/src/pages/guides/packaging.md new file mode 100644 index 000000000..467b70bae --- /dev/null +++ b/src/pages/guides/packaging.md @@ -0,0 +1,47 @@ +--- +keywords: + - Adobe I/O + - Extensibility + - ISV + - Developer Tooling +--- + + +# App Builder Packaging for Developer Distribution + +To get your App Buikder app listed for [Adobe Developer Distribution](https://developer.adobe.com/developer-distribution/), you will need to package it. + +The `aio app pack` command will verify and bundle your app. + +In the root of your app folder, run this command: + +```sh +aio app pack +``` + +After this command is run, you can find your app package in your app folder: `dist/app.zip`. + +## Hooks + +Two new [hooks](./app-hooks.md) have been added for this command, and will run and after the command is run: + +1. pre-pack +2. post-pack + +Your hook handler function will be passed two items: + +1. `appConfig` (object) - this contains the config of the current application +2. `artifactsFolder` (string) - this will be the location of the folder containing all the packaging artifacts that will be bundled + +## App Validation + +1. `app.config.yaml` + - will be checked if it is in a valid format, and will show specific config errors for you to fix if necessary +2. `package.json` version + - application version format must be `X.Y.Z`, where X, Y, and Z are non-negative integers +3. files to be packaged. All the files in your app folder will be packaged EXCEPT: + - files specified in `.gitignore` + - files specified in `.npmignore` + - any `dist` folders + - any OS junk files (.DS_Store, thumbs.db, etc) +4. event registrations will be validated (if any) \ No newline at end of file From d69ecb8f634875dfd2783ff2f151b994b54cc398 Mon Sep 17 00:00:00 2001 From: Shazron Abdullah Date: Thu, 21 Mar 2024 19:37:49 +0800 Subject: [PATCH 2/4] add toc entry --- gatsby-config.js | 4 ++++ src/pages/guides/packaging.md | 34 ++++++++++++++++------------------ 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/gatsby-config.js b/gatsby-config.js index f96556fd4..07f1b8d0e 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -98,6 +98,10 @@ module.exports = { { "title": "Event hooks for App Builder Applications", "path": "guides/app-hooks.md" + }, + { + "title": "Packaging for Developer Distribution", + "path": "guides/packaging.md" } ] }, diff --git a/src/pages/guides/packaging.md b/src/pages/guides/packaging.md index 467b70bae..4251def90 100644 --- a/src/pages/guides/packaging.md +++ b/src/pages/guides/packaging.md @@ -7,31 +7,17 @@ keywords: --- -# App Builder Packaging for Developer Distribution +# Packaging for Developer Distribution To get your App Buikder app listed for [Adobe Developer Distribution](https://developer.adobe.com/developer-distribution/), you will need to package it. -The `aio app pack` command will verify and bundle your app. - -In the root of your app folder, run this command: +The `aio app pack` command will verify and bundle your app. In the root of your app folder, run this command: ```sh aio app pack ``` -After this command is run, you can find your app package in your app folder: `dist/app.zip`. - -## Hooks - -Two new [hooks](./app-hooks.md) have been added for this command, and will run and after the command is run: - -1. pre-pack -2. post-pack - -Your hook handler function will be passed two items: - -1. `appConfig` (object) - this contains the config of the current application -2. `artifactsFolder` (string) - this will be the location of the folder containing all the packaging artifacts that will be bundled +After this command completes running, you can find your app package in your app folder: `dist/app.zip`. ## App Validation @@ -44,4 +30,16 @@ Your hook handler function will be passed two items: - files specified in `.npmignore` - any `dist` folders - any OS junk files (.DS_Store, thumbs.db, etc) -4. event registrations will be validated (if any) \ No newline at end of file +4. event registrations will be validated (if any) + +## Hooks + +Two new [hooks](./app-hooks.md) have been added for this command, and will run and after the command is run: + +1. pre-pack +2. post-pack + +Your hook handler function will be passed two items: + +1. `appConfig` (object) - this contains the config of the current application +2. `artifactsFolder` (string) - this will be the location of the folder containing all the packaging artifacts that will be bundled From f7b562e81c9517d84f3b66fa6f18b611569d1fda Mon Sep 17 00:00:00 2001 From: Shazron Abdullah Date: Thu, 21 Mar 2024 22:22:36 +0800 Subject: [PATCH 3/4] minor edits --- src/pages/guides/packaging.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/pages/guides/packaging.md b/src/pages/guides/packaging.md index 4251def90..d7d73edb5 100644 --- a/src/pages/guides/packaging.md +++ b/src/pages/guides/packaging.md @@ -17,24 +17,25 @@ The `aio app pack` command will verify and bundle your app. In the root of your aio app pack ``` -After this command completes running, you can find your app package in your app folder: `dist/app.zip`. +After this command completes running, you can find the app package in your app folder as: `dist/app.zip`. ## App Validation 1. `app.config.yaml` - - will be checked if it is in a valid format, and will show specific config errors for you to fix if necessary + - will be checked if it is in a valid format, and will show specific config errors for you to fix, if necessary 2. `package.json` version - application version format must be `X.Y.Z`, where X, Y, and Z are non-negative integers 3. files to be packaged. All the files in your app folder will be packaged EXCEPT: - files specified in `.gitignore` - files specified in `.npmignore` - any `dist` folders + - any dot files (.env, .gitignore, etc) - any OS junk files (.DS_Store, thumbs.db, etc) 4. event registrations will be validated (if any) ## Hooks -Two new [hooks](./app-hooks.md) have been added for this command, and will run and after the command is run: +Two new [hooks](./app-hooks.md) have been added for this command, and will run before and after the command is run (respectively): 1. pre-pack 2. post-pack From a834d5959ad9d3e1b393d047c525d9160a73fd81 Mon Sep 17 00:00:00 2001 From: Jesse MacFadyen Date: Thu, 21 Mar 2024 14:30:49 -0700 Subject: [PATCH 4/4] ficks typo --- src/pages/guides/packaging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/guides/packaging.md b/src/pages/guides/packaging.md index d7d73edb5..af6307b87 100644 --- a/src/pages/guides/packaging.md +++ b/src/pages/guides/packaging.md @@ -9,7 +9,7 @@ keywords: # Packaging for Developer Distribution -To get your App Buikder app listed for [Adobe Developer Distribution](https://developer.adobe.com/developer-distribution/), you will need to package it. +To get your App Builder app listed for [Adobe Developer Distribution](https://developer.adobe.com/developer-distribution/), you will need to package it. The `aio app pack` command will verify and bundle your app. In the root of your app folder, run this command: