Cattr Redmine Integration — Frontend

A Vue 2 interface extension for Cattr Server. It provides Redmine instance management, user authorization, project selection, and priority/status mappings, with English and Russian translations.

Use it together with the backend module, which supplies the integration API and synchronization services.

Requirements

The package runs inside Cattr's frontend and uses its Vue runtime, frontend aliases, services, and webpack module loader. It ships JavaScript, Vue components, and localization files for compilation by Cattr; it has no standalone build.

This repository uses Node.js 24 (.nvmrc) and pnpm 10.34.5 (packageManager). Use the build tools required by your Cattr server when rebuilding the host application.

Installation from npm

After the package is published, run from the server-application root:

pnpm add @amazingcat/cattr-redmine-integration

Add this entry to resources/frontend/etc/modules.local.json, preserving existing settings:

{
  "AmazingCat_RedmineIntegration": {
    "type": "package",
    "ref": "@amazingcat/cattr-redmine-integration",
    "enabled": true
  }
}

For configuration tracked by your deployment repository, use modules.config.json or the configuration for the relevant environment instead of the local file. Choose a package version compatible with the backend and rebuild the interface:

pnpm install
pnpm prod

Installation from Source

These commands run from the server-application root and assume the repository is checked out at modules/CattrRedmineIntegration, as described in the backend README.

mkdir -p resources/frontend/vendor_modules/AmazingCat
ln -s ../../../../modules/CattrRedmineIntegration/frontend resources/frontend/vendor_modules/AmazingCat/RedmineIntegration

Register the local module in resources/frontend/etc/modules.local.json:

{
  "AmazingCat_RedmineIntegration": {
    "type": "local",
    "ref": "AmazingCat_RedmineIntegration",
    "enabled": true
  }
}

Install the server's dependencies and rebuild:

pnpm install
pnpm prod

Use one installation method at a time. Publishing to npm is not required for source installation.

Verification

After rebuilding, open company settings and check the Redmine integration section. Create or edit an instance and verify its priority/status mappings. In user settings, check authorization for a Redmine account and project selection. Confirm that the backend API is reachable and that synchronization works with a test instance.

For local package maintenance, run from this repository's frontend/ directory:

nvm install
nvm use
corepack enable
pnpm install --frozen-lockfile
npm pack --dry-run

The npm package includes this README, LICENSE, module.init.js, components/, locales/, sections/, and services/. Backend files and development configuration are excluded by the package's files allowlist.

Publishing

The maintainer publishes @amazingcat/[email protected] manually as a public package. This establishes the package before configuring Trusted Publishing.

In the package settings on npmjs.com, add a GitHub Actions trusted publisher with:

• Organization: cattr-app
• Repository: redmine-integration
• Workflow filename: npm-publish.yml (without the directory)
• Environment: leave blank; the workflow does not declare an environment
• Allow direct publishing with npm publish if the settings expose allowed actions

The npm account must have publication rights in the @amazingcat scope. The GitHub repository must be public for provenance. See npm's Trusted Publishing documentation.

For subsequent releases, publish a GitHub Release for a SemVer tag such as v0.0.1 or v0.1.0-rc.1; tags without the leading v are also supported. The release: published workflow checks out that tag, derives the npm version from Git, and requires it to match the release tag after removing a leading v. The source package.json may remain at 0.0.0: the workflow updates it only in the runner and creates no commit or tag.

Regular releases publish with the npm dist-tag latest. GitHub prereleases and versions with a SemVer prerelease suffix publish with next. Each version can be published only once, so do not run the release workflow for the manually published 0.0.0 version.

The workflow uses Node 24, npm 11, a GitHub-hosted runner, and id-token: write. It invokes npm publish directly with OIDC; no NPM_TOKEN or NODE_AUTH_TOKEN secret is needed. Package contents are checked with npm pack --dry-run before publication. The old Yarn and GitLab registry settings have been removed.

License

Server Side Public License 1.0 (SSPL-1.0).