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

feat(release): add cargo-dist #88

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ashleygwilliams
Copy link

@ashleygwilliams ashleygwilliams commented Aug 15, 2024

this PR updates the release workflow for this package to build binaries for mac/windows/linux/linuxmusl, as well as shell/powershell installers. this will ease the install process for folks and eliminate the need for folks to compile using cargo-install.

this also shifts the burden of maintaining the workflow file to the cargo-dist tool - which generates the workflow file from configuration.

you can run this locally by installing cargo-dist and then running cargo dist plan.

announcing v0.7.7
  mdbook-linkcheck 0.7.7
    source.tar.gz
      [checksum] source.tar.gz.sha256
    mdbook-linkcheck-installer.sh
    mdbook-linkcheck-installer.ps1
    mdbook-linkcheck-aarch64-apple-darwin-update
    mdbook-linkcheck-aarch64-apple-darwin.tar.xz
      [bin] mdbook-linkcheck
      [misc] LICENSE, README.md
      [checksum] mdbook-linkcheck-aarch64-apple-darwin.tar.xz.sha256
    mdbook-linkcheck-x86_64-apple-darwin-update
    mdbook-linkcheck-x86_64-apple-darwin.tar.xz
      [bin] mdbook-linkcheck
      [misc] LICENSE, README.md
      [checksum] mdbook-linkcheck-x86_64-apple-darwin.tar.xz.sha256
    mdbook-linkcheck-x86_64-pc-windows-msvc-update
    mdbook-linkcheck-x86_64-pc-windows-msvc.zip
      [bin] mdbook-linkcheck.exe
      [misc] LICENSE, README.md
      [checksum] mdbook-linkcheck-x86_64-pc-windows-msvc.zip.sha256
    mdbook-linkcheck-x86_64-unknown-linux-gnu-update
    mdbook-linkcheck-x86_64-unknown-linux-gnu.tar.xz
      [bin] mdbook-linkcheck
      [misc] LICENSE, README.md
      [checksum] mdbook-linkcheck-x86_64-unknown-linux-gnu.tar.xz.sha256

things to sort:

  • we could add additional targets or installers (homebrew/MUSL/etc)
  • install dir, this PR uses CARGO_HOME which is what cargo install defaults to. however, the manual binary instructions in the README suggest a relative dir. this is customizable using the install_path key in config.

we use mdbook-linkcheck in our documentation for cargo-dist and appreciate you maintaining it!!

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.

1 participant