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

fix: 🐛 Declare GenerateManualPlugin as plugin product #456

Merged
merged 1 commit into from Aug 13, 2022

Conversation

MarcoEidinger
Copy link
Contributor

Closes: #455

ArgumentParser 1.1.3 includes a SwiftPM plugin for generating man pages. However, this plugin is not visible to packages that declare ArgumentParser as a package dependency.

Defining a product of type plugin in the package manifest will solve that. Running swift package plugin --list for a package, that declares ArgumentParser as a package dependency, will then list the GenerateManualPlugin

‘experimental-generate-manual’ (plugin ‘GenerateManualPlugin’ in package ‘swift-argument-parser’)

Checklist

  • I've added at least one test that validates that my change is working, if appropriate
  • I've followed the code style of the rest of the project
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary

Copy link
Contributor

@rauhul rauhul left a comment

Choose a reason for hiding this comment

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

Thanks

@rauhul
Copy link
Contributor

rauhul commented Jul 18, 2022

@swift-ci please test

@MarcoEidinger
Copy link
Contributor Author

Is this PR good to be merged or do you need anything else?

@rauhul
Copy link
Contributor

rauhul commented Jul 22, 2022

Yeah it looks good to me but I'd like @natecook1000 to sign off first.

@MarcoEidinger
Copy link
Contributor Author

Hi @natecook1000, this PR provides the fix for generating man pages from the consumer's package root. Would love to see this getting merged soon :)

@rauhul
Copy link
Contributor

rauhul commented Aug 7, 2022

I believe Nate will be able to approve this in the upcoming week; sorry about the wait.

@rauhul
Copy link
Contributor

rauhul commented Aug 13, 2022

Spoke to Nate offline and this looks good. Thanks for your patience!

@rauhul rauhul merged commit 898d1ae into apple:main Aug 13, 2022
@MarcoEidinger MarcoEidinger deleted the plugin branch August 13, 2022 22:47
@MarcoEidinger
Copy link
Contributor Author

Awesome! What is the ETA for a new release (1.1.4) that will include the fix? After all, the feature to generate man pages is otherwise only working for people pinning to the main branch.

@rauhul
Copy link
Contributor

rauhul commented Aug 27, 2022

1.1.4 has been released with this fix.

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.

GenerateManualPlugin is not available as package plugin
2 participants