Skip to content

Commit

Permalink
[chore] Update CHANGELOG and README
Browse files Browse the repository at this point in the history
Co-authored-by: Kevin Kohrt <[email protected]>
Signed-off-by: Kevin Kohrt <[email protected]>
Signed-off-by: Jacob Sheehy <[email protected]>
  • Loading branch information
lessthanjacob and kkohrt committed Jan 23, 2025
1 parent 74cf67c commit df619e8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
23 changes: 18 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## 2.0.0
## 2.1.0 : 2025-01-24 [diff](https://github.com/procore-oss/handcuffs/compare/v2.0.0..main)

### Added

- Ability to specify prerequisite phases in a non-linear order

### Changed

- (internal) bumped rspec-rails gem version in development dependencies
- (internal) bumped minimum gem versions in test Rails app
- (internal) update github workflow


## 2.0.0 : 2024-02-20 [diff](https://github.com/procore-oss/handcuffs/compare/v1.4.1..v2.0.0)

### Removed

- **BREAKING CHANGE**: Removed support for Ruby < 2.7, Rails < 6.1, PostgreSQL < 12.

### Added

Expand All @@ -24,7 +41,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Updated Bundler to 2.4.22.
- Added Appraisal for dummy app testing.
- Moved repo to procore-oss

### Removed

- BREAKING CHANGE: Removed support for Ruby < 2.7, Rails < 6.1, PostgreSQL < 12.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Handcuffs.configure do |config|
end
```

If you have more complex or asynchrous workflows, you can use an alternate hash notation that allows pre-requisite stages to be specified explicitly:
If you have more complex or asynchrous workflows, you can use an alternate hash notation that allows prerequisite stages to be specified explicitly:

```ruby
# config/initializers/handcuffs.rb
Expand All @@ -75,7 +75,7 @@ The default phase order in this case is determined by [Tsort](https://github.com
rake handcuffs:phase_order
```

This will display the default order in which phases will be run and list the pre-requisites of each phase. It will raise an error if there are any circular dependencies or if any pre-requisite is not a valid phase name.
This will display the default order in which phases will be run and list the prerequisites of each phase. It will raise an error if there are any circular dependencies or if any prerequisite is not a valid phase name.

### Tagging Migrations

Expand Down Expand Up @@ -121,7 +121,7 @@ or
rake 'handcuffs:migrate[post_restart]'
```

*Note:* If you run phases out of order, or attempt to run a phase before outstanding migrations with a prerequisite phase have been run, a `HandcuffsPhaseOutOfOrderError` will be raised.
*Note:* If you run phases out of order, or attempt to run a phase before outstanding migrations with a prerequisite phase have been run, a `HandcuffsPhaseOutOfOrderError` will be raised.

### Running All Migrations

Expand Down

0 comments on commit df619e8

Please sign in to comment.