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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tools: add support for phpDocumentor #498

Merged

Conversation

jrfnl
Copy link
Contributor

@jrfnl jrfnl commented Sep 19, 2021


name: 馃帀 New Feature
about: Add a new feature
labels: enhancement

A Pull Request should be associated with a Discussion.

Related discussion: #497

Description

This PR adds support for the phpDocumentor tool via the tools input to setup-php.

phpDocumentor has also been aliased to phpdoc for convenience.

I have added a test to the linux test for the base name and to the darwin test for the alias.
馃憠馃徎 Should I also add a test to the windows test ?
馃憠馃徎 Should I add a test for downloading different versions ?

In case this PR introduced TypeScript/JavaScript code changes:

  • I have written test cases for the changes in this pull request
  • I have run npm run format before the commit.
  • I have run npm run lint before the commit.
  • I have run npm run release before the commit.
  • npm test returns with no unit test errors and all code covered.

Note: running these scripts, automatically added two unrelated changes to the PR, which I have manually removed (had to disable the pre-commit hook to do so). The changes were to package-lock.json and to dist/index.js. Not sure what's going on there.

In case this PR edits any scripts:

  • I have checked the edited scripts for syntax.
  • I have tested the changes in an integration test (If yes, provide workflow YAML and link).

@shivammathur shivammathur merged commit 2534596 into shivammathur:develop Sep 19, 2021
@shivammathur
Copy link
Owner

@jrfnl

Do not worry about the changes in package-lock.json and dist/index.js. They could be because of different node or npm versions on my machine from yours. You can let them be in the PR as I update all the dependencies before the release and these files are updated.

One test for the latest is fine.

The PR is perfect. Merging it

@jrfnl jrfnl deleted the feature/tools-add-phpdocumentor branch September 19, 2021 23:59
@jrfnl
Copy link
Contributor Author

jrfnl commented Sep 20, 2021

@shivammathur Thanks for letting me know. And happy to help with this PR. Next one coming up in a moment.

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

Successfully merging this pull request may close these issues.

None yet

2 participants