Parodos

Welcome to the parodos plugin!

Setup

1. Install the plugin into the Backstage app in packages/app

yarn add --cwd packages/app @parodos/plugin-parodos

2. Add the /parodos/ route in /packages/app/src/App.tsx

import { ParodosPage } from '@parodos/plugin-parodos';

const routes = (
  <FlatRoutes>
    // ...
    <Route path="/parodos" element={<ParodosPage />} />
  </FlatRoutes>

3. Add Parodos link to the sidebar in packages/app/src/components/Root.tsx

   3.1. Add MeetingRoomIcon import to the top of the file

   import MeetingRoomIcon from '@material-ui/icons/MeetingRoom';

   3.2. Add <SidebarItem icon={MeetingRoomIcon} to="/parodos" text="Parodos" /> after Create... icon. The result will look like this.

   <SidebarItem icon={CreateComponentIcon} to="create" text="Create..." />
   <SidebarItem icon={MeetingRoomIcon} to="/parodos" text="Parodos" />

4. Add /parodos endpoint to the proxy config in app-config.yaml.

'/parodos':
  target: 'http://localhost:8080/api/v1'
  changeOrigin: true
  redirect: follow
  cache: 'no-cache'
  headers:
    Content-Type: 'application/json'
    accept: 'application/json'

'/parodos-notifications':
  target: 'http://localhost:8081/api/v1'
  changeOrigin: true
  redirect: follow
  cache: 'no-cache'
  headers:
    Content-Type: 'application/json'
    accept: 'application/json'

Local development

For local development, the application username is test, password test.

In addition, the Parodos services need to be running. Please refer up-to-date instructions there, but as a short-cut:

git clone https://github.com/parodos-dev/parodos.git
cd parodos
mvn clean install
cd ./workflow-examples

If the action is failing on an expired token, it can be updated here: https://github.com/organizations/parodos-dev/settings/secrets/actions
./start_workflow_service.sh &
./start_notification_service.sh &

By doing that, there will be two services running at http://localhost:8080 and http://localhost:8081.

Node and package manager versions

While developing the plugin, it is recommended to use volta to ensure the same node and package manager versions are maintained across environments.

Intallation instructions can be found here.

Release

The project is published to the NPM JS Registry on release: https://www.npmjs.com/package/@parodos/plugin-parodos.

To do a release:

• go to the project release page: https://github.com/parodos-dev/backstage-parodos/releases
• click Create a new release
• as a tag, use format vX.Y.Z (mind the v prefix!)
• as a title, use the same value as for the tag
• let the release notes to be generated, adjust
• click Publish release

The on-release GitHub action is triggered, leading to publishing the new version to the NPM registry.

To watch progress: https://github.com/parodos-dev/backstage-parodos/actions/workflows/on-release.yaml

If the action is failing on an expired token, it can be updated here: https://github.com/organizations/parodos-dev/settings/secrets/actions

As a side-effect of the action, a PR bumping the plugin version is created. Do not forget to merge it: https://github.com/parodos-dev/backstage-parodos/pulls