Skip to content

Commit

Permalink
CI-docs: Apply TitleCase Consistently, add to Root README, "Test" lin…
Browse files Browse the repository at this point in the history
…k lower as well (#2907)
  • Loading branch information
CodeCasterNL committed Sep 4, 2022
1 parent 87d8ac8 commit 76ee84c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion build/target-repository/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,12 @@ By [buying a book](https://leanpub.com/rector-the-power-of-automated-refactoring

### For Rule Developers and Contributors

- [How to add Test for Rector Rule](/docs/how_to_add_test_for_rector_rule.md)
- [How Does Rector Work?](/docs/how_it_works.md)
- [PHP Parser Nodes](https://github.com/rectorphp/php-parser-nodes-docs/)
- [How to Work with Doc Block and Comments](/docs/how_to_work_with_doc_block_and_comments.md)
- [How to Create Own Rector Rule](/docs/create_own_rule.md)
- [How to add Test for Rector Rule](/docs/how_to_add_test_for_rector_rule.md)
- [How to Persist Cache Between CI Runs](/docs/how_to_persist_cache_between_ci_runs.md)

See [the full documentation](/docs).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How To Persist Cache Between CI Runs
# How to Persist Cache Between CI Runs
While parsing your application code, Rector generates objects representing that code. It caches these objects for later reuse, so it doesn't have to parse the entire application again, by detecting which files have changed since the last Rector run.

When running Rector in a Continuous Integration (CI) system such as [GitHub Actions](https://github.com/features/actions), the default implementation [uses an in-memory cache](https://github.com/rectorphp/rector/blob/1d28ca109ca536e8034c3c756ee61c65e6e63c8a/config/config.php#L89-L94). This means the next job that runs, will have to parse all code from scratch.
Expand All @@ -19,7 +19,7 @@ return static function (RectorConfig $rectorConfig): void {

Note that this caches relative to the repository directory, so it's the same directory on build as on development (and other environments). The actual path, when not specified, may vary per (runner) OS.

## Debugging the cache locally
## Debugging the Cache Locally
Generate the cache on your development machine, by running the command:
```bash
vendor/bin/rector process --dry-run --config=rector.php
Expand Down

0 comments on commit 76ee84c

Please sign in to comment.