Skip to content

Commit

Permalink
doc: CONTRIBUTING.md to document the release process
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
flavorjones committed Oct 20, 2022
1 parent d0265ad commit cf9aa9d
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Contributing to tailwindcss-rails

This doc is a brief introduction on modifying and maintaining this gem.

## Updating to the latest upstream tailwindcss version

Update `lib/tailwindcss/upstream.rb` with the upstream version.

Run `bundle exec rake clobber` then `bundle exec rake download` to ensure the tailwindcss binaries can be downloaded, and that you have the correct versions on local disk.

## Cutting a release

- bump the version
- [ ] update `lib/tailwindcss/version.rb`
- [ ] update `CHANGELOG.md`
- [ ] commit and create a git tag
- build the native gems:
- [ ] `bundle exec rake clobber` to clean up possibly-old tailwindcss executables
- [ ] `bundle exec rake package`
- push
- [ ] `for g in pkg/*.gem ; do gem push $g ; done`
- [ ] `git push`
- announce
- [ ] create a release at https://github.com/rails/tailwindcss-rails/releases

0 comments on commit cf9aa9d

Please sign in to comment.