diff --git a/.dockerignore b/.dockerignore
index 3b81744d2d..9ba3d848a3 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -25,4 +25,6 @@ npm-debug.log.*
# Webpack files
webpack.records.json
-package-lock.json
+
+# Yarn no longer used
+yarn.lock
diff --git a/.eslintrc.json b/.eslintrc.json
index af1b97849b..929afa80ab 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -8,7 +8,15 @@
"eslint-plugin-deprecation",
"unused-imports",
"eslint-plugin-lodash",
- "eslint-plugin-jsonc"
+ "eslint-plugin-jsonc",
+ "eslint-plugin-rxjs",
+ "eslint-plugin-simple-import-sort",
+ "eslint-plugin-import-newlines",
+ "dspace-angular-ts",
+ "dspace-angular-html"
+ ],
+ "ignorePatterns": [
+ "lint/test/fixture"
],
"overrides": [
{
@@ -18,7 +26,8 @@
"parserOptions": {
"project": [
"./tsconfig.json",
- "./cypress/tsconfig.json"
+ "./cypress/tsconfig.json",
+ "./lint/tsconfig.json"
],
"createDefaultProgram": true
},
@@ -27,17 +36,32 @@
"plugin:@typescript-eslint/recommended",
"plugin:@typescript-eslint/recommended-requiring-type-checking",
"plugin:@angular-eslint/recommended",
- "plugin:@angular-eslint/template/process-inline-templates"
+ "plugin:@angular-eslint/template/process-inline-templates",
+ "plugin:rxjs/recommended"
],
"rules": {
+ "indent": [
+ "error",
+ 2,
+ {
+ "SwitchCase": 1,
+ "ignoredNodes": [
+ "ClassBody.body > PropertyDefinition[decorators.length > 0] > .key"
+ ]
+ }
+ ],
"max-classes-per-file": [
"error",
1
],
"comma-dangle": [
- "off",
+ "error",
"always-multiline"
],
+ "object-curly-spacing": [
+ "error",
+ "always"
+ ],
"eol-last": [
"error",
"always"
@@ -104,15 +128,13 @@
"allowTernary": true
}
],
- "prefer-const": "off", // todo: re-enable & fix errors (more strict than it used to be in TSLint)
+ "prefer-const": "error",
+ "no-case-declarations": "error",
+ "no-extra-boolean-cast": "error",
"prefer-spread": "off",
"no-underscore-dangle": "off",
-
- // todo: disabled rules from eslint:recommended, consider re-enabling & fixing
"no-prototype-builtins": "off",
"no-useless-escape": "off",
- "no-case-declarations": "off",
- "no-extra-boolean-cast": "off",
"@angular-eslint/directive-selector": [
"error",
@@ -139,10 +161,10 @@
}
],
"@angular-eslint/no-attribute-decorator": "error",
- "@angular-eslint/no-forward-ref": "error",
"@angular-eslint/no-output-native": "warn",
"@angular-eslint/no-output-on-prefix": "warn",
"@angular-eslint/no-conflicting-lifecycle": "warn",
+ "@angular-eslint/use-lifecycle-interface": "error",
"@typescript-eslint/no-inferrable-types":[
"error",
@@ -183,7 +205,7 @@
],
"@typescript-eslint/type-annotation-spacing": "error",
"@typescript-eslint/unified-signatures": "error",
- "@typescript-eslint/ban-types": "warn", // todo: deal with {} type issues & re-enable
+ "@typescript-eslint/ban-types": "error",
"@typescript-eslint/no-floating-promises": "warn",
"@typescript-eslint/no-misused-promises": "warn",
"@typescript-eslint/restrict-plus-operands": "warn",
@@ -200,17 +222,65 @@
"@typescript-eslint/no-unsafe-return": "off",
"@typescript-eslint/restrict-template-expressions": "off",
"@typescript-eslint/require-await": "off",
+ "@typescript-eslint/no-base-to-string": [
+ "error",
+ {
+ "ignoredTypeNames": [
+ "ResourceType",
+ "Error"
+ ]
+ }
+ ],
"deprecation/deprecation": "warn",
+ "simple-import-sort/imports": "error",
+ "simple-import-sort/exports": "error",
"import/order": "off",
+ "import/first": "error",
+ "import/newline-after-import": "error",
+ "import/no-duplicates": "error",
"import/no-deprecated": "warn",
"import/no-namespace": "error",
+ "import-newlines/enforce": [
+ "error",
+ {
+ "items": 1,
+ "semi": true,
+ "forceSingleLine": true
+ }
+ ],
+
"unused-imports/no-unused-imports": "error",
"lodash/import-scope": [
"error",
"method"
- ]
+ ],
+
+ "rxjs/no-nested-subscribe": "off", // todo: go over _all_ cases
+
+ // Custom DSpace Angular rules
+ "dspace-angular-ts/themed-component-classes": "error",
+ "dspace-angular-ts/themed-component-selectors": "error",
+ "dspace-angular-ts/themed-component-usages": "error"
+ }
+ },
+ {
+ "files": [
+ "*.spec.ts"
+ ],
+ "parserOptions": {
+ "project": [
+ "./tsconfig.json",
+ "./cypress/tsconfig.json"
+ ],
+ "createDefaultProgram": true
+ },
+ "rules": {
+ "prefer-const": "off",
+
+ // Custom DSpace Angular rules
+ "dspace-angular-ts/themed-component-usages": "error"
}
},
{
@@ -221,9 +291,10 @@
"plugin:@angular-eslint/template/recommended"
],
"rules": {
- // todo: re-enable & fix errors
- "@angular-eslint/template/no-negated-async": "off",
- "@angular-eslint/template/eqeqeq": "off"
+ // Custom DSpace Angular rules
+ "dspace-angular-html/themed-component-usages": "error",
+ "dspace-angular-html/no-disabled-attribute-on-button": "error",
+ "@angular-eslint/template/prefer-control-flow": "error"
}
},
{
@@ -231,10 +302,13 @@
"*.json5"
],
"extends": [
- "plugin:jsonc/recommended-with-jsonc"
+ "plugin:jsonc/recommended-with-json5"
],
"rules": {
- "no-irregular-whitespace": "error",
+ // The ESLint core no-irregular-whitespace rule doesn't work well in JSON
+ // See: https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-irregular-whitespace.html
+ "no-irregular-whitespace": "off",
+ "jsonc/no-irregular-whitespace": "error",
"no-trailing-spaces": "error",
"jsonc/comma-dangle": [
"error",
diff --git a/.gitattributes b/.gitattributes
index 406640bfcc..b5ad93b1bc 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -13,4 +13,7 @@
*.css eol=lf
*.scss eol=lf
*.html eol=lf
-*.svg eol=lf
\ No newline at end of file
+*.svg eol=lf
+
+# Generated documentation should have LF line endings to reduce git noise
+docs/lint/**/*.md eol=lf
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 8e4ed0811d..0cce2848a7 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,16 +7,16 @@ assignees: ''
---
-**Describe the bug**
+## Describe the bug
A clear and concise description of what the bug is. Include the version(s) of DSpace where you've seen this problem & what *web browser* you were using. Link to examples if they are public.
-**To Reproduce**
+## To Reproduce
Steps to reproduce the behavior:
1. Do this
2. Then this...
-**Expected behavior**
+## Expected behavior
A clear and concise description of what you expected to happen.
-**Related work**
+## Related work
Link to any related tickets or PRs here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 34cc2c9e4f..9eaa4d9f3f 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,14 +7,14 @@ assignees: ''
---
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+## Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem or use case is. For example, I'm always frustrated when [...]
-**Describe the solution you'd like**
+## Describe the solution you'd like
A clear and concise description of what you want to happen.
-**Describe alternatives or workarounds you've considered**
+## Describe alternatives or workarounds you've considered
A clear and concise description of any alternative solutions or features you've considered.
-**Additional context**
-Add any other context or screenshots about the feature request here.
+## Additional information
+Add any other information, related tickets or screenshots about the feature request here.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000000..b53e501d29
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,298 @@
+#-------------------
+# DSpace's dependabot rules. Enables npm updates for all dependencies on a weekly basis
+# for main and any maintenance branches. Security updates only apply to main.
+#-------------------
+version: 2
+updates:
+ ###############
+ ## Main branch
+ ###############
+ # NOTE: At this time, "security-updates" rules only apply if "target-branch" is unspecified
+ # So, only this first section can include "applies-to: security-updates"
+ - package-ecosystem: "npm"
+ directory: "/"
+ schedule:
+ interval: "weekly"
+ # Allow up to 10 open PRs for dependencies
+ open-pull-requests-limit: 10
+ # Group together Angular package upgrades
+ groups:
+ # Group together all minor/patch version updates for Angular in a single PR
+ angular:
+ applies-to: version-updates
+ patterns:
+ - "@angular*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together all security updates for Angular. Only accept minor/patch types.
+ angular-security:
+ applies-to: security-updates
+ patterns:
+ - "@angular*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together all minor/patch version updates for NgRx in a single PR
+ ngrx:
+ applies-to: version-updates
+ patterns:
+ - "@ngrx*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together all security updates for NgRx. Only accept minor/patch types.
+ ngrx-security:
+ applies-to: security-updates
+ patterns:
+ - "@ngrx*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together all patch version updates for eslint in a single PR
+ eslint:
+ applies-to: version-updates
+ patterns:
+ - "@typescript-eslint*"
+ - "eslint*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together all security updates for eslint.
+ eslint-security:
+ applies-to: security-updates
+ patterns:
+ - "@typescript-eslint*"
+ - "eslint*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any testing related version updates
+ testing:
+ applies-to: version-updates
+ patterns:
+ - "@cypress*"
+ - "axe-*"
+ - "cypress*"
+ - "jasmine*"
+ - "karma*"
+ - "ng-mocks"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any testing related security updates
+ testing-security:
+ applies-to: security-updates
+ patterns:
+ - "@cypress*"
+ - "axe-*"
+ - "cypress*"
+ - "jasmine*"
+ - "karma*"
+ - "ng-mocks"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any postcss related version updates
+ postcss:
+ applies-to: version-updates
+ patterns:
+ - "postcss*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any postcss related security updates
+ postcss-security:
+ applies-to: security-updates
+ patterns:
+ - "postcss*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any sass related version updates
+ sass:
+ applies-to: version-updates
+ patterns:
+ - "sass*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any sass related security updates
+ sass-security:
+ applies-to: security-updates
+ patterns:
+ - "sass*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any webpack related version updates
+ webpack:
+ applies-to: version-updates
+ patterns:
+ - "webpack*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any webpack related seurity updates
+ webpack-security:
+ applies-to: security-updates
+ patterns:
+ - "webpack*"
+ update-types:
+ - "minor"
+ - "patch"
+ ignore:
+ # Ignore all major version updates for all dependencies. We'll only automate minor/patch updates.
+ - dependency-name: "*"
+ update-types: ["version-update:semver-major"]
+ #####################
+ ## dspace-8_x branch
+ #####################
+ - package-ecosystem: "npm"
+ directory: "/"
+ target-branch: dspace-8_x
+ schedule:
+ interval: "weekly"
+ # Allow up to 10 open PRs for dependencies
+ open-pull-requests-limit: 10
+ # Group together Angular package upgrades
+ groups:
+ # Group together all patch version updates for Angular in a single PR
+ angular:
+ applies-to: version-updates
+ patterns:
+ - "@angular*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together all minor/patch version updates for NgRx in a single PR
+ ngrx:
+ applies-to: version-updates
+ patterns:
+ - "@ngrx*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together all patch version updates for eslint in a single PR
+ eslint:
+ applies-to: version-updates
+ patterns:
+ - "@typescript-eslint*"
+ - "eslint*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any testing related version updates
+ testing:
+ applies-to: version-updates
+ patterns:
+ - "@cypress*"
+ - "axe-*"
+ - "cypress*"
+ - "jasmine*"
+ - "karma*"
+ - "ng-mocks"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any postcss related version updates
+ postcss:
+ applies-to: version-updates
+ patterns:
+ - "postcss*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any sass related version updates
+ sass:
+ applies-to: version-updates
+ patterns:
+ - "sass*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any webpack related version updates
+ webpack:
+ applies-to: version-updates
+ patterns:
+ - "webpack*"
+ update-types:
+ - "minor"
+ - "patch"
+ ignore:
+ # Ignore all major version updates for all dependencies. We'll only automate minor/patch updates.
+ - dependency-name: "*"
+ update-types: ["version-update:semver-major"]
+ #####################
+ ## dspace-7_x branch
+ #####################
+ - package-ecosystem: "npm"
+ directory: "/"
+ target-branch: dspace-7_x
+ schedule:
+ interval: "weekly"
+ # Allow up to 10 open PRs for dependencies
+ open-pull-requests-limit: 10
+ # Group together Angular package upgrades
+ groups:
+ # Group together all minor/patch version updates for Angular in a single PR
+ angular:
+ applies-to: version-updates
+ patterns:
+ - "@angular*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together all minor/patch version updates for NgRx in a single PR
+ ngrx:
+ applies-to: version-updates
+ patterns:
+ - "@ngrx*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together all patch version updates for eslint in a single PR
+ eslint:
+ applies-to: version-updates
+ patterns:
+ - "@typescript-eslint*"
+ - "eslint*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any testing related version updates
+ testing:
+ applies-to: version-updates
+ patterns:
+ - "@cypress*"
+ - "axe-*"
+ - "cypress*"
+ - "jasmine*"
+ - "karma*"
+ - "ng-mocks"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any postcss related version updates
+ postcss:
+ applies-to: version-updates
+ patterns:
+ - "postcss*"
+ update-types:
+ - "minor"
+ - "patch"
+ # Group together any sass related version updates
+ sass:
+ applies-to: version-updates
+ patterns:
+ - "sass*"
+ update-types:
+ - "minor"
+ - "patch"
+ ignore:
+ # 7.x Cannot update Webpack past v5.76.1 as later versions not supported by Angular 15
+ # See also https://github.com/DSpace/dspace-angular/pull/3283#issuecomment-2372488489
+ - dependency-name: "webpack"
+ # Ignore all major version updates for all dependencies. We'll only automate minor/patch updates.
+ - dependency-name: "*"
+ update-types: ["version-update:semver-major"]
diff --git a/.github/disabled-workflows/pull_request_opened.yml b/.github/disabled-workflows/pull_request_opened.yml
deleted file mode 100644
index 0dc718c0b9..0000000000
--- a/.github/disabled-workflows/pull_request_opened.yml
+++ /dev/null
@@ -1,26 +0,0 @@
-# This workflow runs whenever a new pull request is created
-# TEMPORARILY DISABLED. Unfortunately this doesn't work for PRs created from forked repositories (which is how we tend to create PRs).
-# There is no known workaround yet. See https://github.community/t/how-to-use-github-token-for-prs-from-forks/16818
-name: Pull Request opened
-
-# Only run for newly opened PRs against the "main" branch
-on:
- pull_request:
- types: [opened]
- branches:
- - main
-
-jobs:
- automation:
- runs-on: ubuntu-latest
- steps:
- # Assign the PR to whomever created it. This is useful for visualizing assignments on project boards
- # See https://github.com/marketplace/actions/pull-request-assigner
- - name: Assign PR to creator
- uses: thomaseizinger/assign-pr-creator-action@v1.0.0
- # Note, this authentication token is created automatically
- # See: https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token
- with:
- repo-token: ${{ secrets.GITHUB_TOKEN }}
- # Ignore errors. It is possible the PR was created by someone who cannot be assigned
- continue-on-error: true
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index e50105b879..14bd09f5e3 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,7 +1,7 @@
## References
_Add references/links to any related issues or PRs. These may include:_
-* Fixes #`issue-number` (if this fixes an issue ticket)
-* Requires DSpace/DSpace#`pr-number` (if a REST API PR is required to test this)
+* Fixes #issue-number (if this fixes an issue ticket)
+* Requires DSpace/DSpace#pr-number (if a REST API PR is required to test this)
## Description
Short summary of changes (1-2 sentences).
@@ -16,13 +16,18 @@ List of changes in this PR:
**Include guidance for how to test or review your PR.** This may include: steps to reproduce a bug, screenshots or description of a new feature, or reasons behind specific changes.
## Checklist
-_This checklist provides a reminder of what we are going to look for when reviewing your PR. You need not complete this checklist prior to creating your PR (draft PRs are always welcome). If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!_
+_This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
+However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!_
-- [ ] My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
-- [ ] My PR passes [ESLint](https://eslint.org/) validation using `yarn lint`
-- [ ] My PR doesn't introduce circular dependencies (verified via `yarn check-circ-deps`)
-- [ ] My PR includes [TypeDoc](https://typedoc.org/) comments for _all new (or modified) public methods and classes_. It also includes TypeDoc for large or complex private methods.
-- [ ] My PR passes all specs/tests and includes new/updated specs or tests based on the [Code Testing Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Testing+Guide).
+- [ ] My PR is **created against the `main` branch** of code (unless it is a backport or is fixing an issue specific to an older branch).
+- [ ] My PR is **small in size** (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
+- [ ] My PR **passes [ESLint](https://eslint.org/)** validation using `npm run lint`
+- [ ] My PR **doesn't introduce circular dependencies** (verified via `npm run check-circ-deps`)
+- [ ] My PR **includes [TypeDoc](https://typedoc.org/) comments** for _all new (or modified) public methods and classes_. It also includes TypeDoc for large or complex private methods.
+- [ ] My PR **passes all specs/tests and includes new/updated specs or tests** based on the [Code Testing Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Testing+Guide).
+- [ ] My PR **aligns with [Accessibility guidelines](https://wiki.lyrasis.org/display/DSDOC8x/Accessibility)** if it makes changes to the user interface.
+- [ ] My PR **uses i18n (internationalization) keys** instead of hardcoded English text, to allow for translations.
+- [ ] My PR **includes details on how to test it**. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
- [ ] If my PR includes new libraries/dependencies (in `package.json`), I've made sure their licenses align with the [DSpace BSD License](https://github.com/DSpace/DSpace/blob/main/LICENSE) based on the [Licensing of Contributions](https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines#CodeContributionGuidelines-LicensingofContributions) documentation.
- [ ] If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
- [ ] If my PR fixes an issue ticket, I've [linked them together](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 219074780e..e13d8f75d7 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -7,7 +7,8 @@ name: Build
on: [push, pull_request]
permissions:
- contents: read # to fetch code (actions/checkout)
+ contents: read # to fetch code (actions/checkout)
+ packages: read # to fetch private images from GitHub Container Registry (GHCR)
jobs:
tests:
@@ -33,21 +34,26 @@ jobs:
#CHROME_VERSION: "90.0.4430.212-1"
# Bump Node heap size (OOM in CI after upgrading to Angular 15)
NODE_OPTIONS: '--max-old-space-size=4096'
+ # Project name to use when running "docker compose" prior to e2e tests
+ COMPOSE_PROJECT_NAME: 'ci'
+ # Docker Registry to use for Docker compose scripts below.
+ # We use GitHub's Container Registry to avoid aggressive rate limits at DockerHub.
+ DOCKER_REGISTRY: ghcr.io
strategy:
# Create a matrix of Node versions to test against (in parallel)
matrix:
- node-version: [16.x, 18.x]
+ node-version: [18.x, 20.x]
# Do NOT exit immediately if one matrix job fails
fail-fast: false
# These are the actual CI steps to perform per job
steps:
# https://github.com/actions/checkout
- name: Checkout codebase
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
# https://github.com/actions/setup-node
- name: Install Node.js ${{ matrix.node-version }}
- uses: actions/setup-node@v3
+ uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
@@ -67,63 +73,77 @@ jobs:
fi
google-chrome --version
- # https://github.com/actions/cache/blob/main/examples.md#node---yarn
- - name: Get Yarn cache directory
- id: yarn-cache-dir-path
- run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
- - name: Cache Yarn dependencies
- uses: actions/cache@v3
+ # https://github.com/actions/cache/blob/main/examples.md#node---npm
+ - name: Get NPM cache directory
+ id: npm-cache-dir
+ run: echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT
+ - name: Cache NPM dependencies
+ uses: actions/cache@v4
with:
- # Cache entire Yarn cache directory (see previous step)
- path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
- # Cache key is hash of yarn.lock. Therefore changes to yarn.lock will invalidate cache
- key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
- restore-keys: ${{ runner.os }}-yarn-
+ # Cache entire NPM cache directory (see previous step)
+ path: ${{ steps.npm-cache-dir.outputs.dir }}
+ # Cache key is hash of package-lock.json. Therefore changes to package-lock.json will invalidate cache
+ key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
+ restore-keys: ${{ runner.os }}-npm-
- - name: Install Yarn dependencies
- run: yarn install --frozen-lockfile
+ - name: Install NPM dependencies
+ run: npm clean-install
+
+ - name: Build lint plugins
+ run: npm run build:lint
+
+ - name: Run lint plugin tests
+ run: npm run test:lint:nobuild
- name: Run lint
- run: yarn run lint --quiet
+ run: npm run lint:nobuild -- --quiet
- name: Check for circular dependencies
- run: yarn run check-circ-deps
+ run: npm run check-circ-deps
- name: Run build
- run: yarn run build:prod
+ run: npm run build:prod
- name: Run specs (unit tests)
- run: yarn run test:headless
+ run: npm run test:headless
# Upload code coverage report to artifact (for one version of Node only),
# so that it can be shared with the 'codecov' job (see below)
# NOTE: Angular CLI only supports code coverage for specs. See https://github.com/angular/angular-cli/issues/6286
- name: Upload code coverage report to Artifact
- uses: actions/upload-artifact@v3
+ uses: actions/upload-artifact@v4
if: matrix.node-version == '18.x'
with:
- name: dspace-angular coverage report
+ name: coverage-report-${{ matrix.node-version }}
path: 'coverage/dspace-angular/lcov.info'
retention-days: 14
- # Using docker-compose start backend using CI configuration
+ # Login to our Docker registry, so that we can access private Docker images using "docker compose" below.
+ - name: Login to ${{ env.DOCKER_REGISTRY }}
+ uses: docker/login-action@v3
+ with:
+ registry: ${{ env.DOCKER_REGISTRY }}
+ username: ${{ github.repository_owner }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
+ # Using "docker compose" start backend using CI configuration
# and load assetstore from a cached copy
- name: Start DSpace REST Backend via Docker (for e2e tests)
run: |
- docker-compose -f ./docker/docker-compose-ci.yml up -d
- docker-compose -f ./docker/cli.yml -f ./docker/cli.assetstore.yml run --rm dspace-cli
+ docker compose -f ./docker/docker-compose-ci.yml up -d
+ docker compose -f ./docker/cli.yml -f ./docker/cli.assetstore.yml run --rm dspace-cli
docker container ls
# Run integration tests via Cypress.io
# https://github.com/cypress-io/github-action
# (NOTE: to run these e2e tests locally, just use 'ng e2e')
- name: Run e2e tests (integration tests)
- uses: cypress-io/github-action@v5
+ uses: cypress-io/github-action@v6
with:
# Run tests in Chrome, headless mode (default)
browser: chrome
# Start app before running tests (will be stopped automatically after tests finish)
- start: yarn run serve:ssr
+ start: npm run serve:ssr
# Wait for backend & frontend to be available
# NOTE: We use the 'sites' REST endpoint to also ensure the database is ready
wait-on: http://127.0.0.1:8080/server/api/core/sites, http://127.0.0.1:4000
@@ -133,19 +153,19 @@ jobs:
# Cypress always creates a video of all e2e tests (whether they succeeded or failed)
# Save those in an Artifact
- name: Upload e2e test videos to Artifacts
- uses: actions/upload-artifact@v3
+ uses: actions/upload-artifact@v4
if: always()
with:
- name: e2e-test-videos
+ name: e2e-test-videos-${{ matrix.node-version }}
path: cypress/videos
# If e2e tests fail, Cypress creates a screenshot of what happened
# Save those in an Artifact
- name: Upload e2e test failure screenshots to Artifacts
- uses: actions/upload-artifact@v3
+ uses: actions/upload-artifact@v4
if: failure()
with:
- name: e2e-test-screenshots
+ name: e2e-test-screenshots-${{ matrix.node-version }}
path: cypress/screenshots
- name: Stop app (in case it stays up after e2e tests)
@@ -159,7 +179,7 @@ jobs:
# Start up the app with SSR enabled (run in background)
- name: Start app in SSR (server-side rendering) mode
run: |
- nohup yarn run serve:ssr &
+ nohup npm run serve:ssr &
printf 'Waiting for app to start'
until curl --output /dev/null --silent --head --fail http://127.0.0.1:4000/home; do
printf '.'
@@ -170,17 +190,89 @@ jobs:
# Get homepage and verify that the tag includes "DSpace".
# If it does, then SSR is working, as this tag is created by our MetadataService.
# This step also prints entire HTML of homepage for easier debugging if grep fails.
- - name: Verify SSR (server-side rendering)
+ - name: Verify SSR (server-side rendering) on Homepage
run: |
result=$(wget -O- -q http://127.0.0.1:4000/home)
echo "$result"
echo "$result" | grep -oE "]*>" | grep DSpace
+ # Get a specific community in our test data and verify that the "
" tag includes "Publications" (the community name).
+ # If it does, then SSR is working.
+ - name: Verify SSR on a Community page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/communities/0958c910-2037-42a9-81c7-dca80e3892b4)
+ echo "$result"
+ echo "$result" | grep -oE "
]*>[^><]*
" | grep Publications
+
+ # Get a specific collection in our test data and verify that the "
" tag includes "Articles" (the collection name).
+ # If it does, then SSR is working.
+ - name: Verify SSR on a Collection page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/collections/282164f5-d325-4740-8dd1-fa4d6d3e7200)
+ echo "$result"
+ echo "$result" | grep -oE "