Setup `dev` environment for workspaces

[Ben Lambert]

Since we moved over the plugins from backstage/backstage the migrated plugins maybe do not already have a dev setup.

For a start, we should ensure that all workspaces, and their plugins have the ability to start standalone using yarn start.

This means copying implementations and prior art from backstage/backstage like the following:

auth backend src/dev/index.ts

home frontend src/dev/index.tsx

Tasks

Beta Give feedback

1. adr
2. airbrake
3. allure
4. analytics
5. apache-airflow
6. apollo-explorer
7. azure-devops
8. azure-sites
9. badges
10. bazaar
11. bitrise
12. cicd-statistics
13. cloudbuild
14. code-climate
15. code-coverage
16. codescene
17. cost-insights
18. dynatrace
19. entity-feedback #577
20. entity-validation
21. explore
22. firehydrant
23. fossa
24. gcalendar
25. gcp-projects
26. git-release-manager
27. github-actions
28. github-deployments
29. github-issues
30. github-pull-requests-board
31. gitops-profiles
32. gocd
33. graphiql
34. graphql-voyager
35. ilert
36. jenkins #560
37. kafka
38. lighthouse
39. linguist
40. microsoft-calendar
41. newrelic
42. nomad
43. octopus-deploy
44. opencost
45. periskop
46. playlist
47. puppetdb
48. repo-tools
49. rollbar
50. sentry
51. shortcuts
52. sonarqube
53. splunk
54. stack-overflow
55. stackstorm
56. tech-insights: #524
57. tech-radar
58. todo
59. vault #536
60. xcmetrics

Once we have done a few PR's and have examples, this ticket might turn into a good first issue.

[Katharina Sick]

Hi,

I'm currently trying to set up a dev environment for the Jenkins plugin. To do that, I mainly copied from the linguist plugin that @awanlin used to create a sample. I copied all the stuff, created a very simple Backstage app and everything seems to be working fine. I can run frontend & backend separately or just start the full Backstage app with yarn dev. When doing the latter, the app starts & shows me my entities. It only starts to fail when adding the EntityJenkinsRunCard to the EntityPage.tsx:

<Grid item md={6}>
    <EntityLatestJenkinsRunCard
        branch="main,master"
        variant="gridItem"
    />
</Grid>

As soon as the EntityJenkinsRunCard is added, I get the below error in the UI (nothing in the logs though). No matter if the Jenkins annotation is defined or not.

TypeError
Cannot read properties of null (reading 'useContext')

Do you have an idea what could be going on here? Once I manage to resolve this issue, I can contribute the dev setup for Jenkins :)

EDIT: I'm sorry, I didn't check other issues first because I assumed that I did something wrong. I now did that and my problems could be related to #501

[Vincenzo Scamporlino]

Hi @KatharinaSick, thank you for looking into this 🙏
Could you share a branch so that we can look better at the issue?

[Katharina Sick]

Of course! Thank you 🙂
I pushed everything to https://github.com/KatharinaSick/backstage-community-plugins/tree/jenkins-dev-env

In my app-config.local.yaml I just have the Jenkins configuration:

jenkins:
  baseUrl: https://jenkins-instance.com
  username: xxx
  apiKey: xxx

[Vincenzo Scamporlino]

Of course! Thank you 🙂 I pushed everything to https://github.com/KatharinaSick/backstage-community-plugins/tree/jenkins-dev-env

In my app-config.local.yaml I just have the Jenkins configuration:

jenkins:
  baseUrl: https://jenkins-instance.com
  username: xxx
  apiKey: xxx

@KatharinaSick I think the issue was due to a mismatch on the installed dependencies. Running yarn dedupe in workspace/jenkins should fix the issue

[Gido Koning]

Of course! Thank you 🙂 I pushed everything to https://github.com/KatharinaSick/backstage-community-plugins/tree/jenkins-dev-env

In my app-config.local.yaml I just have the Jenkins configuration:

jenkins:
  baseUrl: https://jenkins-instance.com
  username: xxx
  apiKey: xxx

Hello @KatharinaSick when will you make a pull request on the backstage-comunity repository?

[Katharina Sick]

Thanks a lot for your help @vinzscam! 🙂 I just opened a PR.

I'm sorry that it took so long. I was on vacation and then got sick, that's why I was offline for so long.

[Vincenzo Scamporlino]

Thanks a lot for your help @vinzscam! 🙂 I just opened a PR.

I'm sorry that it took so long. I was on vacation and then got sick, that's why I was offline for so long.

No worries, thank you so much for dedicating your time to this, I hope you feel better!