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.

Sign up for GitHub

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

Jump to bottom

use xtasks for release builds and man page generation #333

Merged
merged 5 commits into from
Oct 13, 2022
Merged

use xtasks for release builds and man page generation #333

merged 5 commits into from
Oct 13, 2022

Conversation

b5
Copy link
Member

@b5 b5 commented Oct 13, 2022

This PR adds support for manual pages generated from clap documentation, and the cargo xtask pattern for coding up low-overhead automation in Rust.

@b5 b5 self-assigned this Oct 13, 2022
dignifiedquire
dignifiedquire reviewed Oct 13, 2022
View reviewed changes
xtask/src/main.rs Outdated Show resolved Hide resolved
dignifiedquire
dignifiedquire reviewed Oct 13, 2022
View reviewed changes
xtask/src/main.rs Outdated Show resolved Hide resolved
@b5 b5 marked this pull request as ready for review October 13, 2022 14:21
@b5 b5 requested a review from ramfox October 13, 2022 14:22
@b5 b5 added the docs Improvements or additions to documentation label Oct 13, 2022
@dignifiedquire
Copy link
Contributor

please remove .ds_store :)

dignifiedquire
dignifiedquire reviewed Oct 13, 2022
View reviewed changes
xtask/src/main.rs Outdated Show resolved Hide resolved
dignifiedquire
dignifiedquire reviewed Oct 13, 2022
View reviewed changes
xtask/src/main.rs Outdated Show resolved Hide resolved
ramfox
ramfox previously approved these changes Oct 13, 2022
View reviewed changes
dignifiedquire
dignifiedquire approved these changes Oct 13, 2022
View reviewed changes
Copy link
Contributor

@dignifiedquire dignifiedquire left a comment

Choose a reason for hiding this comment

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

Last note, maybe add something to our development docs and/or the readme about this?

@b5
Copy link
Member Author

b5 commented Oct 13, 2022

yeah, I plan to put a little more work into the actual things that are automated (like generating all release binaries) before listing this tool in DEVELOPERS.md. Also want to talk to @Arqu about how this may-or-may-not intersect with CI tasks

@b5 b5 merged commit 2db7bf0 into main Oct 13, 2022
@b5 b5 deleted the b5/xtask_mangen branch October 13, 2022 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dignifiedquire dignifiedquire dignifiedquire approved these changes

@ramfox ramfox ramfox left review comments

Assignees

@b5 b5

Labels
docs Improvements or additions to documentation
Projects
iroh
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@b5 @dignifiedquire @ramfox