Skip to content

Bugfix/acna 3518 clean build #857

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.

Sign up for GitHub

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

Closed
dthampy wants to merge 11 commits into from
Closed

Bugfix/acna 3518 clean build #857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
902bcbf
feat: add initial commit for clean command
dthampy Apr 14, 2025
9b5e65e
fix: fix the dist directory path
dthampy Apr 16, 2025
7f4a558
chore: update readme
dthampy Apr 16, 2025
e1c8afd
fix: lint errors
dthampy Apr 16, 2025
3e39976
chore: fixing tests and adding missing coverage
dthampy Apr 16, 2025
4abfcaf
chore: add additional test coverage
dthampy Apr 16, 2025
a47d08d
fix: lint error
dthampy Apr 16, 2025
8ddf696
fix: remove unnecessary comments
dthampy Apr 17, 2025
f6b4bc7
feat: add 100% coverage
dthampy Apr 17, 2025
cc3b9e5
fix: comments
dthampy Apr 17, 2025
2ac230b
fix: added the missing lint fix
dthampy Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 83 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
aio-cli-plugin-app
==================
# aio-cli-plugin-app

Create, Build and Deploy Adobe I/O Apps

Expand All @@ -10,13 +9,14 @@ Create, Build and Deploy Adobe I/O Apps
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-app/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-app/)


<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)

- [Usage](#usage)
- [Commands](#commands)
<!-- tocstop -->

# Usage

```sh-session
$ aio plugins:install -g @adobe/aio-cli-plugin-app
$ # OR
Expand All @@ -25,36 +25,39 @@ $ aio app --help
```

# Commands

<!-- commands -->
* [`aio app`](#aio-app)
* [`aio app add`](#aio-app-add)
* [`aio app add action`](#aio-app-add-action)
* [`aio app add ci`](#aio-app-add-ci)
* [`aio app add event`](#aio-app-add-event)
* [`aio app add extension`](#aio-app-add-extension)
* [`aio app add service`](#aio-app-add-service)
* [`aio app add web-assets`](#aio-app-add-web-assets)
* [`aio app build`](#aio-app-build)
* [`aio app create [PATH]`](#aio-app-create-path)
* [`aio app delete`](#aio-app-delete)
* [`aio app delete action [ACTION-NAME]`](#aio-app-delete-action-action-name)
* [`aio app delete ci`](#aio-app-delete-ci)
* [`aio app delete extension`](#aio-app-delete-extension)
* [`aio app delete service`](#aio-app-delete-service)
* [`aio app delete web-assets`](#aio-app-delete-web-assets)
* [`aio app deploy`](#aio-app-deploy)
* [`aio app get-url [ACTION]`](#aio-app-get-url-action)
* [`aio app info`](#aio-app-info)
* [`aio app init [PATH]`](#aio-app-init-path)
* [`aio app install PATH`](#aio-app-install-path)
* [`aio app list`](#aio-app-list)
* [`aio app list extension`](#aio-app-list-extension)
* [`aio app logs`](#aio-app-logs)
* [`aio app pack [PATH]`](#aio-app-pack-path)
* [`aio app run`](#aio-app-run)
* [`aio app test`](#aio-app-test)
* [`aio app undeploy`](#aio-app-undeploy)
* [`aio app use [CONFIG_FILE_PATH]`](#aio-app-use-config_file_path)

- [`aio app`](#aio-app)
- [`aio app add`](#aio-app-add)
- [`aio app add action`](#aio-app-add-action)
- [`aio app add ci`](#aio-app-add-ci)
- [`aio app add event`](#aio-app-add-event)
- [`aio app add extension`](#aio-app-add-extension)
- [`aio app add service`](#aio-app-add-service)
- [`aio app add web-assets`](#aio-app-add-web-assets)
- [`aio app build`](#aio-app-build)
- [`aio app clean-build`](#aio-app-clean-build)
- [`aio app create [PATH]`](#aio-app-create-path)
- [`aio app delete`](#aio-app-delete)
- [`aio app delete action [ACTION-NAME]`](#aio-app-delete-action-action-name)
- [`aio app delete ci`](#aio-app-delete-ci)
- [`aio app delete extension`](#aio-app-delete-extension)
- [`aio app delete service`](#aio-app-delete-service)
- [`aio app delete web-assets`](#aio-app-delete-web-assets)
- [`aio app deploy`](#aio-app-deploy)
- [`aio app get-url [ACTION]`](#aio-app-get-url-action)
- [`aio app info`](#aio-app-info)
- [`aio app init [PATH]`](#aio-app-init-path)
- [`aio app install PATH`](#aio-app-install-path)
- [`aio app list`](#aio-app-list)
- [`aio app list extension`](#aio-app-list-extension)
- [`aio app logs`](#aio-app-logs)
- [`aio app pack [PATH]`](#aio-app-pack-path)
- [`aio app run`](#aio-app-run)
- [`aio app test`](#aio-app-test)
- [`aio app undeploy`](#aio-app-undeploy)
- [`aio app use [CONFIG_FILE_PATH]`](#aio-app-use-config_file_path)

## `aio app`

Expand Down Expand Up @@ -261,6 +264,51 @@ DESCRIPTION

_See code: [src/commands/app/build.js](https://github.com/adobe/aio-cli-plugin-app/blob/13.3.0/src/commands/app/build.js)_

## `aio app clean-build`

Remove build artifacts from the local machine

```
USAGE
$ aio app clean-build [-v] [--actions] [--web-assets] [--dist-dir] [--tracking-files] [--dev] [--prod] [-e <value>...]

FLAGS
-e, --extension=<value>... Clean only a specific extension, this flag can be specified multiple times
-v, --verbose Verbose output
--[no-]actions [default: true] Clean action build artifacts if any
--[no-]web-assets [default: true] Clean web assets build artifacts if any
--dist-dir [default: false] Clean the entire dist directory (preserves deployment tracking)
--[no-]tracking-files [default: true] Clean build tracking file (forces fresh build on next build without affecting deployment tracking)
--dev Clean development web assets
--prod Clean production web assets (default if neither dev nor prod specified)

DESCRIPTION
Remove build artifacts from the local machine
This command removes build artifacts from the local machine without affecting deployed resources.
It helps developers get a clean build environment without having to manually find and delete build files.

EXAMPLES
$ aio app clean-build
# Cleans all build artifacts (actions, web assets, tracking files)

$ aio app clean-build --dev
# Cleans only development web assets and tracking files

$ aio app clean-build --prod
# Cleans only production web assets and tracking files

$ aio app clean-build --no-web-assets
# Cleans only action build artifacts and tracking files

$ aio app clean-build --no-actions
# Cleans only web assets (both dev and prod) and tracking files

$ aio app clean-build --dist-dir
# Cleans entire dist directory while preserving deployment tracking
```

_See code: [src/commands/app/clean-build.js](https://github.com/adobe/aio-cli-plugin-app/blob/13.3.0/src/commands/app/clean-build.js)_

## `aio app create [PATH]`

Create a new Adobe I/O App with default parameters
Expand Down Expand Up @@ -780,4 +828,5 @@ DESCRIPTION
```

_See code: [src/commands/app/use.js](https://github.com/adobe/aio-cli-plugin-app/blob/13.3.0/src/commands/app/use.js)_

<!-- commandsstop -->
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
"eslint-plugin-n": "^15.7.0",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-promise": "^6.6.0",
"istanbul": "^0.4.5",
Copy link
Copy Markdown
Member

@moritzraho moritzraho Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

Copy link
Copy Markdown
Contributor Author

@dthampy dthampy Apr 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yeah I will remove that.
I was consistently running into jest coverage issue for few lines/branches although I added tests for them. So installed to help me identify untested parts of the code. Thanks for pointing that out

"jest": "^29.5.0",
"nock": "^13.2.9",
"oclif": "^4.17.13",
Expand Down
2 changes: 1 addition & 1 deletion src/commands/app/build.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ class Build extends BaseCommand {
aioLogger.debug(`run hook for 'build-actions' for actions in '${name}' returned ${script}`)
spinner.start(`Building actions for '${name}'`)
if (!script) {
builtList = await RuntimeLib.buildActions(config, filterActions, flags['force-build']) // skipCheck is false
builtList = await RuntimeLib.buildActions(config, filterActions, flags['force-build'])
}
if (builtList.length > 0) {
spinner.succeed(chalk.green(`Built ${builtList.length} action(s) for '${name}'`))
Expand Down
Loading