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

package/README.md

@@ -57,4 +57,58 @@ Components, Drupal and Bootstrap bundles are all dependant from the core.
 
 # Releasing
 
-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
+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
+
+# New versions (3.0.0)
+
+Outline:
+- New Drupal theme (foe2024)
+- New version of web-core (3.0.0)
+    - Specific version 3.0.0-alpha.# (Where # increments as needed)
+    - Git branch 3.0.0-dev
+    - Released as the @next tag on NPM
+    - Included alongside the current version via yarn aliases
+        - (yarn add @foeewni/web-core-next@npm:@foeewni/web-core@next)
+    - Used within foe2024 via the above alias (@foeewni/web-core-next)
+    - Docker volume mounts to allow local web-core development/testing without having to publish every tiny change
+Set-up:
+- Check out the 3.0.0-dev branch on web-core
+    - 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)
+- Check out lagoon-develop on cms-drupal8 and create a new feature branch to work on
+- Ensure you've got everything up-to-date (i.e. ./start.sh refresh -y)
+- Edit docker-compose.yml and uncomment line 55 (should be the external-web-core-volume bit)
+- Restart your containers to pick up this change (./start.sh)
+- Set foe2024 as the default Drupal theme: ddrush config-set system.theme default foe2024
+- Clear caches for fun (ddrush cr)
+You can now edit web-core in its own repo, and see the changes in foe2024.
+- 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).
+- For Drupal there's a new dyarn watch:foe2024 (and build: and lint:)
+To publish your local updates to web-core:
+- Increment the alpha version using yarn version --prerelease, and then git push
+    - (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).
+- Update cms-drupal8 to use this new version (it'll take a good few minutes before it's available in NPM/yarn)
+    - First, turn off the volume mount!
+    - Really! Otherwise yarn will delete your local web-core repo!
+    - Comment out the line in docker-compose.yml and then restart your containers
+    - If you get this wrong now it's 100% your fault
+    - Okay, I tried my best
+    - dbash > yarn add @foeewni/web-core-next@npm:@foeewni/web-core@next
+- Commit the updated yarn.lock to your branch on cms-drupal8
+Notes:
+- Don’t commit the default theme change
+- Don't commit the change to docker-compose.yml
+
+Manual Publishing
+- Make sure your account on https://www.npmjs.com/ has 2FA anabled
+- In the command line run `yarn publish` (or `yarn publish --tag next`)
+- Assign the new version when prompted
+
+Pipeline Publishing:
+- To publish through te pipeline you will have to uncomment the publishing line on the appropriate branch
+- Login to https://www.npmjs.com/package/@foeewni/web-core
+- Create a new token that bypasses 2FA https://www.npmjs.com/settings/bwkerenza-foe/tokens/granular-access-tokens/new
+    - Tick "Bypass two-factor authentication (2FA)"
+    - Set Permission to "Read and write"
+    - Expiration can be 7 days
+- Copy the new key to Repository variables https://bitbucket.org/foeewni/web-core/admin/pipelines/repository-variables
+- Run the pipeline to publish