[ACS-12322] Update docs

This commit is contained in:
Shivangi Shree
2026-08-04 11:03:50 +05:30
parent 0d18ee6c8e
commit 1b7bb56103
15 changed files with 49 additions and 48 deletions
+1 -1
View File
@@ -6,4 +6,4 @@ runs:
steps: steps:
- name: Check content UP - name: Check content UP
shell: bash shell: bash
run: pnpm run ci:check-env || exit 1 run: pnpm ci:check-env || exit 1
+1 -1
View File
@@ -38,7 +38,7 @@ runs:
shell: bash shell: bash
run: | run: |
pnpm install --frozen-lockfile pnpm install --frozen-lockfile
pnpm run build.release pnpm build.release
- name: Build and push multi-platform image - name: Build and push multi-platform image
uses: docker/build-push-action@v7 uses: docker/build-push-action@v7
+1 -1
View File
@@ -28,7 +28,7 @@ runs:
shell: bash shell: bash
run: | run: |
pnpm install --frozen-lockfile pnpm install --frozen-lockfile
pnpm run ci:build:many pnpm ci:build:many
- uses: actions/setup-node@v7 - uses: actions/setup-node@v7
name: setup GH registry name: setup GH registry
@@ -53,7 +53,7 @@ runs:
for attempt in $(seq 1 "${SUITE_ATTEMPTS:-1}"); do for attempt in $(seq 1 "${SUITE_ATTEMPTS:-1}"); do
echo "Running playwright tests with options $OPTIONS on browser ${PLAYWRIGHT_BROWSER} (suite attempt $attempt/${SUITE_ATTEMPTS:-1})" echo "Running playwright tests with options $OPTIONS on browser ${PLAYWRIGHT_BROWSER} (suite attempt $attempt/${SUITE_ATTEMPTS:-1})"
if E2E_TARGET=$OPTIONS pnpm run ci:e2e; then if E2E_TARGET=$OPTIONS pnpm ci:e2e; then
exit 0 exit 0
fi fi
if [ "$attempt" -lt "${SUITE_ATTEMPTS:-1}" ]; then if [ "$attempt" -lt "${SUITE_ATTEMPTS:-1}" ]; then
@@ -45,15 +45,15 @@ jobs:
fetch-depth: 2 fetch-depth: 2
- uses: ./.github/actions/before-install - uses: ./.github/actions/before-install
- run: npm ci - run: pnpm install --frozen-lockfile
- name: upload npm logs - name: upload npm logs
uses: actions/upload-artifact@v7 uses: actions/upload-artifact@v7
if: failure() if: failure()
with: with:
name: npm-logs name: npm-logs
path: /home/runner/.npm/_logs/ path: /home/runner/.npm/_logs/
- run: npm run ci:build -- aca-playwright-shared - run: pnpm ci:build -- aca-playwright-shared
- run: npm run build -- $BUILD_OPTS - run: pnpm build -- $BUILD_OPTS
- name: dist cache - name: dist cache
if: ${{ success() }} if: ${{ success() }}
@@ -146,7 +146,7 @@ jobs:
uses: ./.github/actions/before-install uses: ./.github/actions/before-install
- name: Install dependencies - name: Install dependencies
run: npm ci run: pnpm install --frozen-lockfile
- name: Restore dist cache - name: Restore dist cache
uses: actions/cache/restore@v6 uses: actions/cache/restore@v6
@@ -160,15 +160,15 @@ jobs:
- name: Check Search Indexing - name: Check Search Indexing
continue-on-error: true continue-on-error: true
run: npm run ci:check-search-indexing run: pnpm ci:check-search-indexing
env: env:
ADMIN_PASSWORD_SCRIPT: ${{ env.ADMIN_PASSWORD }} ADMIN_PASSWORD_SCRIPT: ${{ env.ADMIN_PASSWORD }}
- name: Before playwright - name: Before playwright
run: npm run ci:playwright:install:all run: pnpm ci:playwright:install:all
- name: Install Playwright system dependencies - name: Install Playwright system dependencies
run: npx playwright install-deps run: pnpm exec playwright install-deps
- name: Run e2e playwright - name: Run e2e playwright
uses: ./.github/actions/run-e2e-playwright uses: ./.github/actions/run-e2e-playwright
+9 -9
View File
@@ -45,11 +45,11 @@ jobs:
- name: lint affected - name: lint affected
if: ${{ github.event_name == 'pull_request' }} if: ${{ github.event_name == 'pull_request' }}
run: pnpm run affected:lint -- --base=origin/develop run: pnpm affected:lint -- --base=origin/develop
- name: lint all - name: lint all
if: ${{ github.event_name != 'pull_request' }} if: ${{ github.event_name != 'pull_request' }}
run: pnpm run ci:lint run: pnpm ci:lint
- run: pnpm run stylelint - run: pnpm stylelint
detect-e2e-only-changes: detect-e2e-only-changes:
name: 'Validate / Detect E2E Only Changes' name: 'Validate / Detect E2E Only Changes'
@@ -96,8 +96,8 @@ jobs:
with: with:
name: npm-logs name: npm-logs
path: /home/runner/.npm/_logs/ path: /home/runner/.npm/_logs/
- run: pnpm run ci:build -- aca-playwright-shared - run: pnpm ci:build -- aca-playwright-shared
- run: pnpm run build -- $BUILD_OPTS - run: pnpm build -- $BUILD_OPTS
- name: dist cache - name: dist cache
if: ${{ success() }} if: ${{ success() }}
@@ -127,11 +127,11 @@ jobs:
- name: Test - name: Test
if: ${{ github.event_name == 'pull_request' }} if: ${{ github.event_name == 'pull_request' }}
run: pnpm run affected:test -- --browsers=ChromeHeadless --watch=false $TEST_OPTS --base=origin/develop run: pnpm affected:test -- --browsers=ChromeHeadless --watch=false $TEST_OPTS --base=origin/develop
- name: Test all - name: Test all
if: ${{ github.event_name != 'pull_request' }} if: ${{ github.event_name != 'pull_request' }}
run: pnpm run ci:test -- $TEST_OPTS run: pnpm ci:test -- $TEST_OPTS
e2es-playwright: e2es-playwright:
if: ${{ !contains(github.event.pull_request.labels.*.name, 'ci:skip-e2e') }} if: ${{ !contains(github.event.pull_request.labels.*.name, 'ci:skip-e2e') }}
@@ -233,12 +233,12 @@ jobs:
- name: Check Search Indexing - name: Check Search Indexing
continue-on-error: true continue-on-error: true
run: pnpm run ci:check-search-indexing run: pnpm ci:check-search-indexing
env: env:
ADMIN_PASSWORD_SCRIPT: ${{ env.ADMIN_PASSWORD }} ADMIN_PASSWORD_SCRIPT: ${{ env.ADMIN_PASSWORD }}
- name: Before playwright - name: Before playwright
run: pnpm run ci:playwright:install run: pnpm ci:playwright:install
- name: Run e2e playwright - name: Run e2e playwright
uses: ./.github/actions/run-e2e-playwright uses: ./.github/actions/run-e2e-playwright
+3 -3
View File
@@ -62,8 +62,8 @@ jobs:
- uses: ./.github/actions/setup - uses: ./.github/actions/setup
- run: pnpm install --frozen-lockfile - run: pnpm install --frozen-lockfile
- run: pnpm run affected:lint -- --base=origin/develop - run: pnpm affected:lint -- --base=origin/develop
- run: pnpm run stylelint - run: pnpm stylelint
unit-tests: unit-tests:
if: github.event_name == 'workflow_dispatch' if: github.event_name == 'workflow_dispatch'
@@ -84,7 +84,7 @@ jobs:
- uses: ./.github/actions/before-install - uses: ./.github/actions/before-install
- run: pnpm install --frozen-lockfile - run: pnpm install --frozen-lockfile
- run: pnpm run affected:test -- --browsers=ChromeHeadless --watch=false $TEST_OPTS --base=origin/develop - run: pnpm affected:test -- --browsers=ChromeHeadless --watch=false $TEST_OPTS --base=origin/develop
publish-docker-registry: publish-docker-registry:
if: ${{ always() }} if: ${{ always() }}
+3 -3
View File
@@ -47,8 +47,8 @@ jobs:
cache: 'pnpm' cache: 'pnpm'
- uses: ./.github/actions/before-install - uses: ./.github/actions/before-install
- run: pnpm install --frozen-lockfile - run: pnpm install --frozen-lockfile
- run: pnpm run ci:build -- aca-playwright-shared - run: pnpm ci:build -- aca-playwright-shared
- run: pnpm run build -- $BUILD_OPTS - run: pnpm build -- $BUILD_OPTS
- name: dist cache - name: dist cache
if: ${{ success() }} if: ${{ success() }}
@@ -134,7 +134,7 @@ jobs:
uses: ./.github/actions/before-e2e uses: ./.github/actions/before-e2e
- name: Before playwright - name: Before playwright
run: pnpm run ci:playwright:install run: pnpm ci:playwright:install
- uses: ./.github/actions/run-e2e-playwright - uses: ./.github/actions/run-e2e-playwright
with: with:
+4 -3
View File
@@ -7,7 +7,8 @@ Please refer to the public [documentation](https://alfresco-content-app.netlify.
| Name | Version | | Name | Version |
|---------|---------| |---------|---------|
| Node.js | 24.x | | Node.js | 24.x |
| Npm | 11.x | | Npm | 11.x |
| Pnpm | 11.x |
## Compatibility ## Compatibility
@@ -48,8 +49,8 @@ Where `<URL>` is the address of the ACS.
Run the following commands: Run the following commands:
```sh ```sh
npm install pnpm install
npm start pnpm start
``` ```
## Unit Tests ## Unit Tests
+4 -4
View File
@@ -119,14 +119,14 @@ Be sure to mention that developers should have a build rule to copy your plugin
Before you publish you should always rebuild the library: Before you publish you should always rebuild the library:
```sh ```sh
npm run build:my-extension pnpm build:my-extension
``` ```
Go to the output folder and run the publish command. Go to the output folder and run the publish command.
```sh ```sh
cd dist/my-extension cd dist/my-extension
npm publish pnpm publish
``` ```
Note, you are required to have a valid [NPM](https://www.npmjs.com/) account. Note, you are required to have a valid [NPM](https://www.npmjs.com/) account.
@@ -138,7 +138,7 @@ See more details in the [Publishing your library](https://github.com/angular/ang
Assuming you have published your extension library to NPM, you can install it using the standard command: Assuming you have published your extension library to NPM, you can install it using the standard command:
```sh ```sh
npm install my-extension pnpm add my-extension
``` ```
This installs the library and all its dependencies. This installs the library and all its dependencies.
@@ -199,7 +199,7 @@ Finally, update the `src/assets/app.extensions.json` file and add a reference to
Run the application and ensure you have an extra navigation sidebar entry: Run the application and ensure you have an extra navigation sidebar entry:
```sh ```sh
npm start pnpm start
``` ```
Click the `My Extension` link and in the main content area you will see the extension component coming from your library. Click the `My Extension` link and in the main content area you will see the extension component coming from your library.
+1 -1
View File
@@ -3,7 +3,7 @@
Running local build with Docker Running local build with Docker
```shell ```shell
npm run build pnpm run build
``` ```
The application is already preconfigured to run alongside backend containers within the Docker Compose. The application is already preconfigured to run alongside backend containers within the Docker Compose.
+1 -1
View File
@@ -5,7 +5,7 @@ If you are working with ADF source code and want to use the modified version wit
Clone the `alfresco-ng2-components` and `alfresco-content-app` repositories in the same folder, and run the following command: Clone the `alfresco-ng2-components` and `alfresco-content-app` repositories in the same folder, and run the following command:
```sh ```sh
npm start -- --configuration=adf pnpm start --configuration=adf
``` ```
Changing the ADF code results in the recompilation and hot-reloading of the ACA application. Changing the ADF code results in the recompilation and hot-reloading of the ACA application.
+2 -2
View File
@@ -68,8 +68,8 @@ npm install -g @nrwl/cli
In the VS Code Terminal (powershell), run the following: In the VS Code Terminal (powershell), run the following:
```sh ```sh
npm install pnpm install
npm start pnpm start
``` ```
The application should open at `http://localhost:4200` by default. The application should open at `http://localhost:4200` by default.
@@ -17,10 +17,10 @@ First create a folder where you would like to place the extensions. i.e. `/exten
Then run the `@nx/angular` library generator using the following command as a template: Then run the `@nx/angular` library generator using the following command as a template:
```console ```console
npx nx generate @nx/angular:library --name=@myorg/my-extension --buildable=true --directory=extensions/myextension --publishable=true --importPath=@myorg/my-extension --projectNameAndRootFormat=as-provided --no-interactive pnpm exec nx generate @nx/angular:library --name=@myorg/my-extension --buildable=true --directory=extensions/myextension --publishable=true --importPath=@myorg/my-extension --projectNameAndRootFormat=as-provided --no-interactive
``` ```
where `name` is the name of the library, `directory` is a directory where the library is placed and `importPath` is the library name used for the import, like `@myorg/my-awesome-lib`. This must be a valid npm package name. where `name` is the name of the library, `directory` is a directory where the library is placed and `importPath` is the library name used for the import, like `@myorg/my-awesome-lib`. This must be a valid pnpm package name.
See the official [Nx Angular library](https://nx.dev/nx-api/angular/generators/library) documentation for more details. See the official [Nx Angular library](https://nx.dev/nx-api/angular/generators/library) documentation for more details.
@@ -38,7 +38,7 @@ Next to validate the changed verify the following:
} }
``` ```
- Test if npm i is working: - Test if pnpm install is working:
# Developing the basics of the ACA extension # Developing the basics of the ACA extension
@@ -161,13 +161,13 @@ Last but not least, edit the package.json file to allow the build of the extensi
Once done, create the build of the extension running the following command. Once done, create the build of the extension running the following command.
npm install my-extension pnpm add my-extension
# Running ACA with the extension included # Running ACA with the extension included
Now that everything is properly developed, its time to launch ADW and see the result. To launch ADW, run the following command from a terminal. Now that everything is properly developed, its time to launch ADW and see the result. To launch ADW, run the following command from a terminal.
npm start pnpm start
What you should see is a new item in left menu of the landing page for ACA, implementing the route to a new page with the following content. Below the screenshot describing what it should look like. What you should see is a new item in left menu of the landing page for ACA, implementing the route to a new page with the following content. Below the screenshot describing what it should look like.
+6 -6
View File
@@ -46,12 +46,12 @@ After Replace:
``` ```
2. Install your dependencies 2. Install your dependencies
```sh ```sh
npm i pnpm i
``` ```
3. Run the application 3. Run the application
```sh ```sh
npm start pnpm start
``` ```
**Note:** The compiler gives errors and complains about adf libraries with has no exported member errors. You can find many errors with different adf libraries. **Note:** The compiler gives errors and complains about adf libraries with has no exported member errors. You can find many errors with different adf libraries.
@@ -98,15 +98,15 @@ Error 2:
You need to update the datetimepicker dependencies. You need to update the datetimepicker dependencies.
```sh ```sh
npm install --save @mat-datetimepicker/core@9 pnpm add @mat-datetimepicker/core@9
npm install --save @mat-datetimepicker/moment@9 pnpm add @mat-datetimepicker/moment@9
``` ```
Make sure you have installed dev dependency for the below dependencies Make sure you have installed dev dependency for the below dependencies
```sh ```sh
npm install --save-dev inquirer@^8.0.0 pnpm add -D inquirer@^8.0.0
npm install --save-dev winston@^3.8.2 pnpm add -D winston@^3.8.2
``` ```
BREAKING CHANGE: webpack < 5 used to include polyfills for node.js core modules by default. BREAKING CHANGE: webpack < 5 used to include polyfills for node.js core modules by default.