Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[chore]: upward-spec doc fixes #1977

Merged
merged 2 commits into from
Nov 27, 2019
Merged

Conversation

sirugh
Copy link
Contributor

@sirugh sirugh commented Nov 14, 2019

You can ignore the description -- I was going to make some changes to the dependencies for upward-spec but decided against that. So this is just some docs changes to fix some issues I ran in when running the steps in the upward-spec readme.

Description

This PR is really in regards to the security issues reported on the upward-php repo.

That said, there is little we can actually do aside from not using tap-diff as the repo hasn't been updated in 4 years. Since we're indirectly using diff through tap-diff which is simply a test reporter (used when you run the upward-spec bin) I think we can resolve this security report as a won't fix. However, if people feel strongly enough we could remove the tap-diff dependency and output entirely. There are a lot of other options for tap output prettifiers but most are really outdated.

So the only change I made here was a fix to the npx command in the readme that wasn't working and to make the test script executable by default so that you can actually run the command.

Related Issue

Doesn't quite close PWA-126. For that we will need to do the steps listed in that ticket.

Verification steps

  1. Run the script that I modified and see it run. Tests still fail but 🤷‍♂

@sirugh sirugh added the version: Patch This changeset includes backwards compatible bug fixes. label Nov 14, 2019
@sirugh sirugh requested a review from zetlen November 14, 2019 17:45
@PWAStudioBot PWAStudioBot added the pkg:upward-spec Pertains to UPWARD specification package. label Nov 14, 2019
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Nov 14, 2019

Messages
📖

Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.

📖 DangerCI Failures related to missing labels/description/linked issues/etc will persist until the next push or next nightly build run (assuming they are fixed).
📖

Associated JIRA tickets: PWA-126.

Generated by 🚫 dangerJS against 9304b01

@sirugh sirugh added the docs documentation label Nov 18, 2019
@sirugh sirugh changed the title [chore]: upward-spec fixes [chore]: upward-spec doc fixes Nov 18, 2019
@sirugh sirugh requested a review from jcalcaben November 18, 2019 15:36
@sirugh sirugh merged commit 361e64e into develop Nov 27, 2019
@sirugh sirugh deleted the rugh/upward-spec-security-issue branch November 27, 2019 15:00
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
docs documentation pkg:upward-spec Pertains to UPWARD specification package. version: Patch This changeset includes backwards compatible bug fixes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants