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

chore: add CI and release workflow #5

Merged
merged 1 commit into from
Dec 30, 2023
Merged

chore: add CI and release workflow #5

merged 1 commit into from
Dec 30, 2023

Conversation

joshka
Copy link
Collaborator

@joshka joshka commented Dec 30, 2023

The CI workflow is just a minimal one

The release workflow uses release-plz. If you haven't used it before, it's fairly simple. When you push changes to the main branch, it automatically keeps a CHANGELOG in sync with the changes and cuts a PR with an update to the CHANGELOG and version. Merging that PR automatically triggers a release of the project to crates.io.

You can see this in action in joshka/tui-big-text#21 - it's very easy to set and forget.

To enable this release workflow can you please:

  1. Enable "Allow GitHub Actions to create and approve pull requests" (last checkbox at https://github.com/azorng/material/settings/actions)
  2. Create a crate publish token at https://crates.io/settings/tokens. The token should have publish-update scope (it only needs to select this crate if you have multiple crates)
  3. Add a new Repository secret named CARGO_REGISTRY_TOKEN at https://github.com/azorng/material/settings/secrets/actions with the token value

@joshka
Copy link
Collaborator Author

joshka commented Dec 30, 2023

(working on fixing the tests in another PR)

@joshka joshka merged commit b4de5a3 into master Dec 30, 2023
1 check passed
@joshka joshka deleted the ci branch December 30, 2023 03:41
@github-actions github-actions bot mentioned this pull request Dec 30, 2023
@joshka joshka mentioned this pull request Dec 30, 2023
3 tasks
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.

None yet

1 participant