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

Improve Github Actions Workflow #25

Open
7 tasks
charliecooper45 opened this issue Dec 8, 2021 · 1 comment
Open
7 tasks

Improve Github Actions Workflow #25

charliecooper45 opened this issue Dec 8, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@charliecooper45
Copy link
Collaborator

This is an extension to issue #24. A number of future improvements were identified as part of that issue:

  • Additional badges on the readme
  • Auto publish documentation
  • Linting (cargo clippy)
  • Formatting (cargo fmt)
  • Auto release management (Github Action generates a release after publish)
  • Changelogs
  • Matrix testing strategy (test on Mac/Windows too)
@devmannic
Copy link
Collaborator

A note about publishing documentation. Unless explicitly disabled in Cargo.toml the API docs will get created by crates.io and published to docs.rs for each cargo publish (ie. each new tag run by the CI) without any more work needed here. However we may also want to setup Github pages to publish docs for the develop branch using the CI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

No branches or pull requests

2 participants