Merge pull request #3 from cabinetoffice/merge-upstream

cjfryer · web-flow · commit f2f22ab1ebbc · 2022-08-01T15:11:07.000+01:00
Merge v12.1.1 of the Prototype Kit
diff --git a/.gitattributes b/.gitattributes
@@ -13,3 +13,4 @@ create-release.sh export-ignore
 internal_docs export-ignore
 update.sh export-ignore
 /CODEOWNERS export-ignore
+/scripts export-ignore
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -11,9 +11,6 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
 
-    env:
-      npm_config_include: 'optional'
-
     steps:
       - uses: actions/checkout@v2
 
@@ -22,6 +19,6 @@ jobs:
           cache: 'npm'
           node-version-file: '.nvmrc'
 
-      - run: npm install --omit=production
+      - run: npm install
 
       - run: npm run lint
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,8 @@
 usage-data-config.json
 # ignore extension SCSS because it's dynamically generated
 lib/extensions/_extensions.scss
+# ignore any release archives
+/govuk-prototype-kit*.zip
 .env
 .sass-cache
 .DS_Store
diff --git a/.npmrc b/.npmrc
@@ -1,4 +1,2 @@
 audit=false
-omit=optional
-optional=false
 script-shell=bash
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+## 12.1.1 (Fix release)
+
 ### Fixes
 
 - [#1333: Fix _unchecked falsey value on check your answers page](https://github.com/alphagov/govuk-prototype-kit/pull/1333)
diff --git a/VERSION.txt b/VERSION.txt
@@ -1 +1 @@
-12.1.0
+12.1.1
diff --git a/__tests__/spec/utils.js b/__tests__/spec/utils.js
@@ -67,7 +67,7 @@ function _mkReleaseArchiveSync ({ archive, prefix }) {
   const ref = child_process.execSync('git stash create', { cwd: repoDir, encoding: 'utf8' }) || 'HEAD'
 
   child_process.execSync(
-    `git archive --worktree-attributes --prefix=${prefix}/ --output=${archive} ${ref}`,
+    `node scripts/create-release-archive --releaseName ${getReleaseVersion()} --destDir ${path.dirname(archive)} ${ref}`,
     { cwd: repoDir }
   )
 }
diff --git a/docs/documentation_routes.js b/docs/documentation_routes.js
@@ -44,7 +44,7 @@ router.get('/download', function (req, res) {
     const version = require('../package.json').version
 
     res.redirect(
-      `https://github.com/alphagov/govuk-prototype-kit/archive/v${version}.zip`
+      `https://github.com/alphagov/govuk-prototype-kit/releases/v${version}/download/govuk-prototype-kit-${version}.zip`
     )
   } else {
     res.redirect(
diff --git a/internal_docs/releasing.md b/internal_docs/releasing.md
@@ -48,9 +48,15 @@ v8.0.0 // After implementing backwards incompatible changes
 
 11. In the description, paste the relevant section from the release notes in the Google Doc.
 
-12. Click 'Publish release'.
+12. Checkout the *main* branch and pull the latest changes.
 
-13. Let the community know about the release
+13. Run `node scripts/create-release-archive`, which will generate a ZIP in the root of this project.
+
+14. Attach the generated ZIP to the release.
+
+15. Click 'Publish release'.
+
+16. Let the community know about the release
 
 Write a brief summary with highlights from the release then send it to the following slack channels:
 
diff --git a/lib/build/dev-server b/lib/build/dev-server
@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const { devServer } = require('./tasks')
 
 devServer()
diff --git a/lib/build/generate-assets b/lib/build/generate-assets
@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const { generateAssets } = require('./tasks.js')
 
 generateAssets()
diff --git a/lib/build/tasks.js b/lib/build/tasks.js
@@ -30,9 +30,9 @@ const v6PublicPath = path.join(paths.public, 'v6')
 function generateAssets () {
   clean()
   sassExtensions()
-  generateSass(appSassPath, appCssPath)
-  generateSass(docsSassPath, appCssPath)
-  generateSass(v6SassPath, v6CssPath)
+  generateCss(appSassPath, appCssPath)
+  generateCss(docsSassPath, appCssPath)
+  generateCss(v6SassPath, v6CssPath)
   copyAssets(paths.assets, paths.public)
   copyAssets(paths.docsAssets, paths.public)
   copyAssets(paths.v6Assets, v6PublicPath)
@@ -64,7 +64,7 @@ function sassExtensions () {
   fs.writeFileSync(path.join(tempSassPath, '_extensions.scss'), fileContents)
 }
 
-function generateSass (sassPath, cssPath) {
+function generateCss (sassPath, cssPath) {
   if (!fs.existsSync(sassPath)) return
   console.log('compiling CSS...')
   fs.mkdirSync(cssPath, { recursive: true })
@@ -106,7 +106,7 @@ function watchSass (sassPath, cssPath) {
   }).on('all', (event, path) => {
     console.log(`watch ${sassPath}`)
     console.log(event, path)
-    generateSass(sassPath, cssPath)
+    generateCss(sassPath, cssPath)
   })
 }
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/scripts/__snapshots__/create-release-archive.test.js.snap b/scripts/__snapshots__/create-release-archive.test.js.snap
diff --git a/scripts/create-release-archive b/scripts/create-release-archive
diff --git a/scripts/create-release-archive.test.js b/scripts/create-release-archive.test.js
diff --git a/server.js b/server.js

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ function _mkReleaseArchiveSync ({ archive, prefix }) {`
`67`	`67`	`const ref = child_process.execSync('git stash create', { cwd: repoDir, encoding: 'utf8' }) \|\| 'HEAD'`
`68`	`68`
`69`	`69`	`child_process.execSync(`
`70`		- `git archive --worktree-attributes --prefix=${prefix}/ --output=${archive} ${ref}`,
	`70`	+ `node scripts/create-release-archive --releaseName ${getReleaseVersion()} --destDir ${path.dirname(archive)} ${ref}`,
`71`	`71`	`{ cwd: repoDir }`
`72`	`72`	`)`
`73`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ router.get('/download', function (req, res) {`
`44`	`44`	`const version = require('../package.json').version`
`45`	`45`
`46`	`46`	`res.redirect(`
`47`		- `https://github.com/alphagov/govuk-prototype-kit/archive/v${version}.zip`
	`47`	+ `https://github.com/alphagov/govuk-prototype-kit/releases/v${version}/download/govuk-prototype-kit-${version}.zip`
`48`	`48`	`)`
`49`	`49`	`} else {`
`50`	`50`	`res.redirect(`