@foeewni/web-core 3.0.0-alpha.2 → 3.0.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -57,4 +57,43 @@ Components, Drupal and Bootstrap bundles are all dependant from the core.
57
57
 
58
58
  # Releasing
59
59
 
60
- Run `npm version [major|minor|patch]` to bump the semantic versioning details within our package.json and push a commit via the usual PR/code review route (i.e. PR to `develop` branch, then PR to `master`.). Check release here https://www.npmjs.com/package/@foeewni/web-core
60
+ Run `npm version [major|minor|patch]` to bump the semantic versioning details within our package.json and push a commit via the usual PR/code review route (i.e. PR to `develop` branch, then PR to `master`.). Check release here https://www.npmjs.com/package/@foeewni/web-core
61
+
62
+ # New versions (3.0.0)
63
+
64
+ Outline:
65
+ - New Drupal theme (foe2024)
66
+ - New version of web-core (3.0.0)
67
+ - Specific version 3.0.0-alpha.# (Where # increments as needed)
68
+ - Git branch 3.0.0-dev
69
+ - Released as the @next tag on NPM
70
+ - Included alongside the current version via yarn aliases
71
+ - (yarn add @foeewni/web-core-next@npm:@foeewni/web-core@next)
72
+ - Used within foe2024 via the above alias (@foeewni/web-core-next)
73
+ - Docker volume mounts to allow local web-core development/testing without having to publish every tiny change
74
+ Set-up:
75
+ - Check out the 3.0.0-dev branch on web-core
76
+ - Also make sure this repo is next to the cms-drupal8 repo (otherwise you'll have to faff an extra bit with docker-compose.yml)
77
+ - Check out lagoon-develop on cms-drupal8 and create a new feature branch to work on
78
+ - Ensure you've got everything up-to-date (i.e. ./start.sh refresh -y)
79
+ - Edit docker-compose.yml and uncomment line 55 (should be the external-web-core-volume bit)
80
+ - Restart your containers to pick up this change (./start.sh)
81
+ - Set foe2024 as the default Drupal theme: ddrush config-set system.theme default foe2024
82
+ - Clear caches for fun (ddrush cr)
83
+ You can now edit web-core in its own repo, and see the changes in foe2024.
84
+ - You'll need to build web-core then trigger a build of foe2024, but you can probably set up the watch scripts in each repo to simplify that (untested).
85
+ - For Drupal there's a new dyarn watch:foe2024 (and build: and lint:)
86
+ To publish your local updates to web-core:
87
+ - Increment the alpha version using yarn version --prerelease, and then git push
88
+ - (The 3.0.0-dev branch is set to publish to @foeewni/web-core/@next, you can see progress in the bitbucket pipelines, and via the NPM versions page).
89
+ - Update cms-drupal8 to use this new version (it'll take a good few minutes before it's available in NPM/yarn)
90
+ - First, turn off the volume mount!
91
+ - Really! Otherwise yarn will delete your local web-core repo!
92
+ - Comment out the line in docker-compose.yml and then restart your containers
93
+ - If you get this wrong now it's 100% your fault
94
+ - Okay, I tried my best
95
+ - dbash > yarn add @foeewni/web-core-next@npm:@foeewni/web-core@next
96
+ - Commit the updated yarn.lock to your branch on cms-drupal8
97
+ Notes:
98
+ - Don’t commit the default theme change
99
+ - Don't commit the change to docker-compose.yml