Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Makes Dredd a monorepo #1531

Merged
merged 5 commits into from
Oct 8, 2019
Merged

Makes Dredd a monorepo #1531

merged 5 commits into from
Oct 8, 2019

Conversation

artem-zakharchenko
Copy link
Contributor

@artem-zakharchenko artem-zakharchenko commented Oct 3, 2019

🚀 Why this change?

  • To manage Dredd and friends more effectively

📝 Related issues and Pull Requests

✅ What didn't I forget?

  • To write docs
  • To write tests
  • To put Conventional Changelog prefixes in front of all my commits and run npm run lint

@artem-zakharchenko
Copy link
Contributor Author

Current state: Managing docs, moved to the root directory, fixing references to fixtures from hooks/index.rst. There were some issues with docutils python dependency being not installed. Should be solved with moving docs to the root.

"e2e:openapi2": "cucumber-js --world-parameters=\"{\\\"apiDescriptionFormat\\\": \\\"application/swagger+yaml\\\"}\"",
"ci:lint": "npm run lint",
"ci:test": "npm test",
"ci:smoke": "bash ./scripts/smoke.sh",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this comment is about the PR itself, but once we have dredd-transactions in the repo too, we will want to alter the smoke tests to test with the in-repo dredd-transactions.

When the time comes for this, you can take a look at how I solved similiar in API Elements where "Fury CLI" uses the local in-repo libraries as part of the smoke test: https://github.com/apiaryio/api-elements.js/blob/dbd6aafbd50fcb2fab43eae9d612561147308377/.circleci/smoke.sh

@pksunkara
Copy link
Contributor

LGTM.

@artem-zakharchenko
Copy link
Contributor Author

@honzajavorek please note that this pull request also brings Yarn as the default package manager to Dredd. The reasoning is the support for "workspaces", which grants an ability to properly install shared dependencies between multiple packages in a monorepo.

Due to that, I'd also update the docs (mainly contributing guidelines) to mention the Yarn preference. What do you think?

@honzajavorek
Copy link
Contributor

@artem-zakharchenko

Yarn as the default package manager to Dredd

For development, right? So we're talking about the "internals" page in the docs. Sure, reasonable.

For Dredd users we should still recommend npm.

@artem-zakharchenko
Copy link
Contributor Author

Yes, of course. Publicly nothing changes, Yarn is preferred for contributing only, not to fix package managers during dependencies management and CI. Well, in that case you're right, nothing to update (except of contributing docs in a separate pull request).

Copy link
Contributor

@honzajavorek honzajavorek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

appveyor.yml Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
@artem-zakharchenko
Copy link
Contributor Author

Experiencing a flaky test (#1519). Re-running the workflow...

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants