Skip to content

Commit 76a7115

Browse files
authored
Merge pull request #323 from wbstack/tarrow-patch-1
Update build-scripts.md
2 parents 199fd7d + 35db14c commit 76a7115

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/build-scripts.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
## Build scripts
22

3+
### Overview
4+
```mermaid
5+
graph TD
6+
A[wikiman.yaml]-->|wikiman|B[pacman.yaml]
7+
B-->|pacman|C[dist folder with things in it]
8+
```
9+
310
### sync.sh
411

512
This script will resync the `dist` directory.
@@ -12,6 +19,10 @@ This is made up of a series of steps:
1219
- `04-docker-compose`: Perform a composer install
1320
- `05-docker-entrypoint-overrides`: Add the WBStack shims to MediaWiki entrypoints
1421

22+
Assuming neither `dist-persist` directory or `pacman.yaml` have changed then running this script should almost be a no-op. The only files we expect to change are composer autoload files and composer's own vendor folder.
23+
24+
There is a GitHub Action [Workflow](../.github/workflows/wbstack.sync.check.yml) running to attempt to ensure that `sync.sh` has been run on every commit so that the dist directory does not get out of sync from what it is built from.
25+
1526
### wikiman & pacman
1627

1728
`wikiman` is a MediaWiki specific yaml generator for pacman.

0 commit comments

Comments
 (0)