Skip to content

Commit

Permalink
remove breaking changes section from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DannyBen committed Nov 4, 2024
1 parent 4aa943e commit 4f48d09
Showing 1 changed file with 0 additions and 67 deletions.
67 changes: 0 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,73 +120,6 @@ $ run example --help

For a more formal documentation, see the [User Guide](https://runfile.dannyb.co/).

## Breaking Changes in 1.0.0

<details>
<summary>Show section</summary>

---

If you are using a version earlier than 1.0, note that version 1.0.0 includes
some breaking changes. You can read more about them in
[this Pull Request](https://github.com/DannyBen/runfile/pull/50).

### Upgrading to 1.0.0

#### No more `.runfile` config

If you have used the multi-runfile config file, this no longer exists.
Use a standard `runfile` instead, along with the `import` directive.

#### No more `action :global`

If you have used the `action :global do` notation, this is replaced with the
simpler use `action do` instead. Also, there is no more need for
empty `usage ''`, just delete it if you have it in your runfiles.

#### No more `execute` directive

If you have used it to cross-call other actions, it is no longer available. As
an alternative, you can define common code in separate classes and `require`
them, or use the new `helpers` directive to define functions that will be
available to all actions.

#### Code outside of actions should be inside `helpers`

If your runfiles include other ruby code, especially `def method`, you should
now use the new `helpers` block and tuck this code inside it.

#### No more need for `trap(:INT)`

If your old runfiles trap the `Interrupt` signal, there is no longer a need to
do so, as it is trapped by default.

#### Colsole is included

If your runfiles `required` and `include` Colsole, there is no longer a need to
do it. Colsole is bundled and available in actions.

#### Long flags before short flags

This is a cosmetic change for consistency. All generated output shows long flags
before short flags `--force, -f` instead of `-f, --force`. Update your custom
`usage` directives accordingly.

#### Examples no longer add implicit 'run'

If you were using the `example` directive, it will no longer add the initial
`run` in front of your examples. Add it yourself. This is intended to allow
providing more elaborate examples.

#### RunfileTasks

The [runfile-tasks gem](https://github.com/dannyben/runfile-tasks) is also
updated to 1.x, with a modified syntax. If you are using it, make sure to
upgrade it as well.

</details>


## Contributing / Support

If you experience any issue, have a question or a suggestion, or if you wish to
Expand Down

0 comments on commit 4f48d09

Please sign in to comment.