Skip to content
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

Merged
merged 13 commits into from
Aug 4, 2020
Merged

Mob/techdocs end to end #1736

merged 13 commits into from
Aug 4, 2020

Conversation

hooloovooo
Copy link
Contributor

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.

@hooloovooo hooloovooo added the area:techdocs Related to the TechDocs Project Area label Jul 24, 2020
@hooloovooo hooloovooo marked this pull request as ready for review July 27, 2020 15:02
@hooloovooo hooloovooo requested a review from a team as a code owner July 27, 2020 15:02
@hooloovooo
Copy link
Contributor Author

@spotify/backstage-core Can we get a review of this?

Co-authored-by: Emma Indal <emma.indahl@gmail.com>
@emmaindal
Copy link
Member

@spotify/backstage-core can we get a review of this?

Copy link
Member

@Rugvip Rugvip left a 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;
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Member

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.

@hooloovooo hooloovooo merged commit 97f3f58 into master Aug 4, 2020
@hooloovooo hooloovooo deleted the mob/techdocs-end-to-end branch August 4, 2020 11:04
benjdlambert added a commit that referenced this pull request Aug 5, 2020
…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
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:techdocs Related to the TechDocs Project Area
Projects
No open projects
3 participants