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

[xtask] New subcommand: Books #1192

Merged
merged 5 commits into from
Jan 31, 2024
Merged

[xtask] New subcommand: Books #1192

merged 5 commits into from
Jan 31, 2024

Conversation

syl20bnr
Copy link
Member

@syl20bnr syl20bnr commented Jan 30, 2024 •
edited
Loading

Pull Request Template

Checklist

  • Confirmed that run-checks all script has been executed.
  • Made sure the book is up to date with changes in this PR.

Changes

Adds a new command to xtask to manage our books:

Run commands to manage Burn Books

Usage: xtask books <COMMAND>

Commands:
  burn         Burn Book, a.k.a. the guide, made for the Burn users
  contributor  Contributor book, made for people willing to get all the technical understanding and advices to contribute actively to the project
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

Burn Book, a.k.a. the guide, made for the Burn users

Usage: xtask books burn <COMMAND>

Arguments:
  <COMMAND>
          Possible values:
          - build: Build the book
          - open:  Open the book on a random port and rebuild it automatically upon changes

Options:
  -h, --help
          Print help (see a summary with '-h')

@codecov Codecov
Copy link

codecov bot commented Jan 30, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b7486b0) 84.47% compared to head (a44513c) 84.44%.
Report is 1 commits behind head on main.

❗ Current head a44513c differs from pull request most recent head 1f521bc. Consider uploading reports for the commit 1f521bc to get more accurate results

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1192       /-   ##
==========================================
- Coverage   84.47%   84.44%   -0.04%     
==========================================
  Files         548      546       -2     
  Lines       61808    61596     -212     
==========================================
- Hits        52213    52014     -199     
  Misses       9595     9582      -13

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Luni-4
Luni-4 requested changes Jan 30, 2024
View reviewed changes
Copy link
Collaborator

@Luni-4 Luni-4 left a comment

Choose a reason for hiding this comment

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

Thanks a lot for your work!

Just some small changes

xtask/src/books.rs Outdated Show resolved Hide resolved
xtask/src/books.rs Show resolved Hide resolved
xtask/src/books.rs Outdated Show resolved Hide resolved
xtask/src/utils/process.rs Show resolved Hide resolved
Luni-4
Luni-4 approved these changes Jan 30, 2024
View reviewed changes
Copy link
Collaborator

@Luni-4 Luni-4 left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

@syl20bnr syl20bnr force-pushed the xtask/new-command-books branch 5 times, most recently from 0cd6dbe to 1f521bc Compare January 31, 2024 04:36
@nathanielsimard nathanielsimard merged commit 02259ea into main Jan 31, 2024
13 checks passed
@nathanielsimard nathanielsimard deleted the xtask/new-command-books branch January 31, 2024 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Luni-4 Luni-4 Luni-4 approved these changes

@nathanielsimard nathanielsimard nathanielsimard approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@syl20bnr @Luni-4 @nathanielsimard