Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

Latest commit

 

History

History
42 lines (31 loc) · 2.06 KB

README.md

File metadata and controls

42 lines (31 loc) · 2.06 KB

CI Maintainability Test Coverage

Ship is an open-source changelog for your product. Share updates about new features with your customers and keep people in the loop!

Deploy to Heroku Deploy to Render

Features

  • Write release notes 10x faster with AI. Leverage OpenAI’s ChatGPT to publish your content in seconds.
  • Pull commits from GitHub. Ship allows you to link changelogs with your GitHub activity, making it easy to track progress. (GitLab coming soon!)
  • Retrieve issues from Linear. We connect changelogs to project management tools of your choice, allowing ChatGPT to stay informed about your current tasks. (Other tools coming soon.)
  • Monthly automated summaries. Each month, Ship handpicks the most notable updates and creates a release note draft for you to review and publish.

Build and run locally

git clone https://github.com/changepack/ship.git
cd ship

# Install dependencies
bundle install
yarn install

# Update environment variables
cp config/application.yml.example config/application.yml

# Run the application
bundle exec rails db:create db:migrate db:seed
bin/test
bundle exec rails s

Use tmuxinator or foreman to run backgrounds processes like guard, a cypruss server, or a tailwindcss watcher.

Contributors 🎉

Looking to contribute? Please refer to our CONTRIBUTING.md file.