CONTRIBUTING.md

Contributing to the Backstage GitHub Releases AutoGov Plugin

Local Testing

1. build & package the plugins

   build & package individually for isolated local testing

   yarn install
   yarn tsc
   cd backstage-plugin-
   yarn build
   yarn pack

   cd ..
   yarn install
   yarn tsc
   cd backstage-plugin-github-releases-assets-backend
   yarn build
   yarn pack

   backend.add(
     import('backstage-plugin-github-releases-assets-backend'),
   );

2. Add the plugins to a local Backstage instance

   cd packages/backend
   yarn add <local-path-to-repo>backstage-plugin-autogov/backstage-plugin-github-releases-autogov/liatrio-backstage-plugin-github-releases-assets-backend-<current-version>.tgz
   ## or run
   yarn --cwd packages/backend <local-path-to-repo>backstage-plugin-autogov/backstage-plugin-github-releases-autogov/liatrio-backstage-plugin-github-releases-assets-backend-<current-version>.tgz

   cd packages/app
   yarn add <local-path-to-repo>backstage-plugin-autogov/backstage-plugin-github-releases-autogov/liatrio-backstage-plugin-github-releases-autogov-<current-version>.tgz
   ## or run
   yarn --cwd packages/app <local-path-to-repo>backstage-plugin-autogov/backstage-plugin-github-releases-autogov/liatrio-backstage-plugin-github-releases-autogov<current-version>.tgz

   import { GithubReleasesAutogovPage } from 'backstage-plugin-github-releases-autogov';
   ...
   
   <EntityLayout.Route
         path="/code-insights"
         title="Code Insights">
         <GithubReleasesAutogovPage />
   </EntityLayout.Route>