-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Mob/techdocs end to end #1736
Mob/techdocs end to end #1736
Conversation
65ac669
to
7efadb8
Compare
…e into mob/techdocs-end-to-end
@spotify/backstage-core Can we get a review of this? |
Co-authored-by: Emma Indal <emma.indahl@gmail.com>
@spotify/backstage-core can we get a review of this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Didn't dig too much into the backend itself, but changes outside look alright 👍
logger: Logger; | ||
database?: Knex; // TODO: Make database required when we're implementing database stuff. | ||
config: Config; | ||
dockerClient: Docker; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This abstraction isn't that useful since it's more or less the concrete dockerode
type and only really leaves room of mocking and decoration. I see it's copied from the scaffolder anyway though, but it could be worth spending some effort here to see if it's possible do depend on something more narrow. Something like a DockerRunner interface.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't find anything better to use in the type declaration. Will revisit some of these things soon and i can have a deeper dive into a better solution then.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah would be an interface defined by the plugin that's tailored to the needs here. Doesn't have to directly match the dockerode client either, you could wrap that a bit if needed.
…g-in-gql * 'master' of github.com:spotify/backstage: (73 commits) chore(gql): graphql should be public chore(deps): bump chokidar from 3.4.0 to 3.4.1 (#1818) chore(deps-dev): bump @types/nodegit from 0.26.5 to 0.26.7 (#1817) chore(deps-dev): bump @testing-library/react-hooks from 3.3.0 to 3.4.1 (#1820) Mob/techdocs end to end (#1736) chore(scaffolder): updating the wording for the sample templates chore(deps): bump react-use from 14.2.0 to 15.3.3 workflows: run cli checks on changes to create-app create-app: sync version create-app: fix deps create-app: add lint command feat(create-app): add missing template backend package plugins/graphql: fix schema packaging create-app: packaging fixes fix(create-app): update entrypoint feat: fallback to string value if config value is not json yarn.lock: security fix (#1797) fix(cli): add create-app import to e2e tests cli: just print warning if postpack fails broken link to create an app ...
A flow for generating techdocs using the previously built parts. Currently accessible as a api /techdocs/buildall with a local server serving the generated files. Heavily inspired from scaffolder-backend, so probably need some more cleanup etc.