Add a script to zip the built examples #30130

XhmikosR · 2020-02-03T09:56:13Z

Fixes #30076

Preview: https://deploy-preview-30130--twbs-bootstrap.netlify.com/docs/4.3/examples/

TODO:

remove integrity and crossorigin attributes
tighten the regex so that it only changes links and script tags, not a tags
maybe copy favicons or remove them from the HTML

package.json

XhmikosR · 2020-02-03T19:39:13Z

Obviously. This is ran after the docs are generated this the folder is present

…

On Mon, Feb 3, 2020, 21:24 Martijn Cuppens ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In package.json <#30130 (comment)>: > "release-sri": "node build/generate-sri.js", "release-version": "node build/change-version.js", "release-zip": "cross-env-shell \"rm -rf bootstrap-$npm_package_version-dist && cp -r dist/ bootstrap-$npm_package_version-dist && zip -r9 bootstrap-$npm_package_version-dist.zip bootstrap-$npm_package_version-dist && rm -rf bootstrap-$npm_package_version-dist\"", + "release-zip-examples": "cross-env-shell \"rm -rf bootstrap-$npm_package_version-examples && cp -r _gh_pages/docs/$npm_package_version_short/examples/ bootstrap-$npm_package_version-examples && rm bootstrap-$npm_package_version-examples/index.html && zip -r9 bootstrap-$npm_package_version-examples.zip bootstrap-$npm_package_version-examples && rm -rf bootstrap-$npm_package_version-examples\"", I got an error when I removed the _gh_pages folder and reran the command. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#30130?email_source=notifications&email_token=AACVLNMUYXNMOU7EDT2FWXTRBBVO3A5CNFSM4KPCFOEKYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCUBL3VY#pullrequestreview-352501207>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACVLNPNDMJU65OOVOLENBDRBBVO3ANCNFSM4KPCFOEA> .

XhmikosR · 2020-02-04T12:48:19Z

How about we mention the examples zip package in getting started?

XhmikosR · 2020-02-04T14:34:01Z

Now that I think about it, I'm not happy with this patch. The asset paths still are /docs/.../css etc, so I don't think this is a good solution to the problem.

I'm not sure how to solve this in an easy way.

XhmikosR · 2020-02-04T14:50:06Z

And even if we set up https://gohugo.io/content-management/urls/#relative-urls, it'll still need further processing to keep the directory structure simple.

Otherwise try this patch:

 config.yml   | 1 +
 package.json | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/config.yml b/config.yml
index 63648ec1a..3ccc68b54 100644
--- a/config.yml
+++ b/config.yml
@@ -10,6 +10,7 @@ markup:
   highlight:
     noClasses:          false
 
+relativeURLs: true
 buildDrafts:            true
 buildFuture:            true
 
diff --git a/package.json b/package.json
index bc78e8882..4e7b1aeb6 100644
--- a/package.json
+++ b/package.json
@@ -61,7 +61,7 @@
     "release-sri": "node build/generate-sri.js",
     "release-version": "node build/change-version.js",
     "release-zip": "cross-env-shell \"rm -rf bootstrap-$npm_package_version-dist && cp -r dist/ bootstrap-$npm_package_version-dist && zip -r9 bootstrap-$npm_package_version-dist.zip bootstrap-$npm_package_version-dist && rm -rf bootstrap-$npm_package_version-dist\"",
-    "release-zip-examples": "cross-env-shell \"rm -rf bootstrap-$npm_package_version-examples && cp -r _gh_pages/docs/$npm_package_version_short/examples/ bootstrap-$npm_package_version-examples && rm bootstrap-$npm_package_version-examples/index.html && zip -r9 bootstrap-$npm_package_version-examples.zip bootstrap-$npm_package_version-examples && rm -rf bootstrap-$npm_package_version-examples\"",
+    "release-zip-examples": "cross-env-shell \"rm -rf bootstrap-$npm_package_version-examples && zip -r9 bootstrap-$npm_package_version-examples.zip _gh_pages/docs/$npm_package_version_short/examples/ _gh_pages/docs/$npm_package_version_short/dist/",
     "dist": "npm-run-all --parallel css js",
     "test": "npm-run-all lint dist js-test docs-build docs-lint",
     "netlify": "npm-run-all dist release-sri docs-production",

XhmikosR · 2020-02-04T16:17:51Z

So basically this works fine:

rm -rf bootstrap-4.3.1-examples && cp -r _gh_pages/docs/4.3/examples/ bootstrap-4.3.1-examples && cp -r _gh_pages/docs/4.3/dist/ bootstrap-4.3.1-examples && rm bootstrap-4.3.1-examples/index.html && find bootstrap-4.3.1-examples -name \"*.html\" -print | xargs sed -i 's#\"/docs/4.3/#\"../#g' && zip -r9 bootstrap-4.3.1-examples.zip bootstrap-4.3.1-examples && rm -rf bootstrap-4.3.1-examples

If I don't find a solution with cross-env-shell, I will just try to move all these to a shell script.

MartijnCuppens · 2020-02-04T18:26:48Z

The bootstrap CSS, JS and favicons are not included in the zip files here

XhmikosR · 2020-02-04T18:34:46Z

The CSS and JS is included for sure. The favicons are not included on purpose.

MartijnCuppens · 2020-02-04T18:43:11Z

Indeed, never mind

MartijnCuppens · 2020-02-04T18:51:18Z

It seems we also need to remove the integrity and crossorigin attributes, otherwise I get cross origin errors when I open the html file through my filesystem:

index.html:1 Access to script at 'file:///Users/martijn.cuppens/workspace/twbs-bootstrap/bootstrap-4.3.1-examples/js/bootstrap.bundle.min.js' from origin 'null' has been blocked by CORS policy: Cross origin requests are only supported for protocol schemes: http, data, chrome, chrome-extension, brave, https.

XhmikosR · 2020-02-04T18:53:48Z

For that I'd need some help, so feel free to tweak the script.

XhmikosR · 2020-04-01T12:14:47Z

@mdo @MartijnCuppens @ffoodd can you guys try this now? Not sure if the regex is perfect, but it seems to work. I also confirmed the dashboard example works since it has 3rd-party scripts.

XhmikosR · 2020-04-01T12:18:01Z

build/zip-examples.sh

+cp -r "_gh_pages/docs/$version_short/examples/" "$folder_name"
+cp -r "_gh_pages/docs/$version_short/dist/" "$folder_name"
+rm "$folder_name/index.html"
+find "$folder_name" -name "*.html" -exec sed -i "s#\"/docs/$version_short/#\"../#g" '{}' \;


Tighten this so that it only changes links and script tags, not a tags

MartijnCuppens · 2020-04-01T17:21:56Z

It works!

Some sidenotes:

The favicons aren't yet copied
Maybe we should remove the "Download sourcecode" button, imo it's an odd place to have it

XhmikosR · 2020-04-01T18:17:17Z

The favicons aren't yet copied

Already in the PR TODO, but I might not be able to remove them and TBH I don't think it's an issue.

Maybe we should remove the "Download sourcecode" button, imo it's an odd place to have it

Unrelated to this PR, though. 😛

Johann-S · 2020-04-02T09:39:26Z

build/zip-examples.js

+
+// remove any previously create folder with the same name
+sh.rm('-rf', folderName)
+sh.mkdir('-p', folderName)


it's a bit weird to use sh here, you can use native Node.js methods to do that, it'll work everywhere

Johann-S · 2020-04-02T09:40:51Z

build/zip-examples.js

+const path = require('path')
+const sh = require('shelljs')
+
+const { version, version_short } = require('../package.json')


const { version, version_short: versionShort } = require('../package.json')

to avoid using: /* eslint-disable camelcase */

XhmikosR · 2020-04-02T09:42:03Z

Sure, feel free to submit a patch ;) I went with something we already have in our devDependencies and it was easier for me. Happy to remove shelljs if you manage to remove it from the other scripts too.

…

On Thu, Apr 2, 2020, 12:39 Johann-S ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In build/zip-examples.js <#30130 (comment)>: > + +const path = require('path') +const sh = require('shelljs') + +const { version, version_short } = require('../package.json') + +const folderName = `bootstrap-${version}-examples` + +sh.config.fatal = true + +// switch to the root dir +sh.cd(path.join(__dirname, '..')) + +// remove any previously create folder with the same name +sh.rm('-rf', folderName) +sh.mkdir('-p', folderName) it's a bit weird to use sh here, you can use native Node.js methods to do that, it'll work everywhere — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#30130 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACVLNJWJWUVIC3PWSK6SQDRKRMOFANCNFSM4KPCFOEA> .

Johann-S · 2020-04-02T09:45:10Z

build/zip-examples.js

+
+/*!
+ * Script to create the built examples zip archive;
+ * requires the `zip` command to be present!


maybe we can add a devDeps to avoid this requirement ?

XhmikosR · 2020-04-02T10:37:42Z

That's a system utility not an npm package.

…

On Thu, Apr 2, 2020, 12:45 Johann-S ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In build/zip-examples.js <#30130 (comment)>: > @@ -0,0 +1,49 @@ +#!/usr/bin/env node + +/*! + * Script to create the built examples zip archive; + * requires the `zip` command to be present! maybe we can add a devDeps to avoid this requirement ? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#30130 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACVLNILCPUHZOJH3KUTNJLRKRNDVANCNFSM4KPCFOEA> .

Johann-S · 2020-04-02T12:48:21Z

@XhmikosR yep and I think we can avoid to have this system requirement by using a dev deps

XhmikosR · 2020-04-02T12:50:54Z

Feel free to suggest another patch. The less dependencies the better for me.

XhmikosR · 2020-04-29T18:01:01Z

I'm gonna merge this as a first patch. Everyone can improve later as needed 🙂

Add a script to zip the built examples

XhmikosR added build v4 v5 backport-to-v4 labels Feb 3, 2020

ffoodd mentioned this pull request Feb 3, 2020

Downloadable Bootstrap Examples #30076

Closed

XhmikosR requested a review from MartijnCuppens February 3, 2020 11:03

MartijnCuppens reviewed Feb 3, 2020

View reviewed changes

package.json Outdated Show resolved Hide resolved

XhmikosR force-pushed the master-xmr-zip-examples branch from 12c7ac7 to ed67acf Compare February 4, 2020 13:14

XhmikosR requested review from mdo and MartijnCuppens February 4, 2020 13:14

XhmikosR force-pushed the master-xmr-zip-examples branch from 0a47957 to 7e22269 Compare February 4, 2020 16:09

XhmikosR force-pushed the master-xmr-zip-examples branch from 8e6bf81 to d648c02 Compare February 4, 2020 16:56

XhmikosR force-pushed the master-xmr-zip-examples branch 3 times, most recently from 0519791 to a5864bd Compare February 5, 2020 13:59

XhmikosR force-pushed the master-xmr-zip-examples branch from a5864bd to 8e2f74c Compare April 1, 2020 11:44

XhmikosR commented Apr 1, 2020

View reviewed changes

Johann-S reviewed Apr 2, 2020

View reviewed changes

Johann-S approved these changes Apr 2, 2020

View reviewed changes

Johann-S reviewed Apr 2, 2020

View reviewed changes

XhmikosR force-pushed the master-xmr-zip-examples branch 2 times, most recently from 1db5c2f to 5ccfa2e Compare April 15, 2020 18:29

XhmikosR added 2 commits April 20, 2020 09:32

Add a script to zip the built examples

9e4c762

Add examples zip in website

3fe4321

XhmikosR force-pushed the master-xmr-zip-examples branch from 5ccfa2e to 97019b8 Compare April 20, 2020 06:33

Switch to a Node.js script using shelljs

5b558c3

XhmikosR force-pushed the master-xmr-zip-examples branch from 97019b8 to 5b558c3 Compare April 20, 2020 06:41

Merge branch 'master' into master-xmr-zip-examples

cefeee7

XhmikosR merged commit df88748 into master Apr 29, 2020

XhmikosR deleted the master-xmr-zip-examples branch April 29, 2020 18:03

XhmikosR added a commit that referenced this pull request Apr 29, 2020

Backport #30130

dc75a42

Add a script to zip the built examples

XhmikosR added a commit that referenced this pull request Apr 30, 2020

Backport #30130

5ec376b

Add a script to zip the built examples

XhmikosR added a commit that referenced this pull request May 2, 2020

Backport #30130

c06a1f3

Add a script to zip the built examples

olsza pushed a commit to olsza/bootstrap that referenced this pull request Oct 3, 2020

Add a script to zip the built examples (twbs#30130)

a69a38a

nelsonni mentioned this pull request Jan 5, 2021

Bump bootstrap from 4.2.1 to 4.5.3 EPICLab/EPICLab.github.io#35

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a script to zip the built examples #30130

Add a script to zip the built examples #30130

XhmikosR commented Feb 3, 2020 •

edited

Loading

XhmikosR commented Feb 3, 2020 via email

XhmikosR commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

MartijnCuppens commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

MartijnCuppens commented Feb 4, 2020

MartijnCuppens commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

XhmikosR commented Apr 1, 2020 •

edited

Loading

XhmikosR Apr 1, 2020

MartijnCuppens commented Apr 1, 2020

XhmikosR commented Apr 1, 2020

Johann-S Apr 2, 2020

Johann-S Apr 2, 2020

XhmikosR commented Apr 2, 2020 via email

Johann-S Apr 2, 2020

XhmikosR commented Apr 2, 2020 via email

Johann-S commented Apr 2, 2020

XhmikosR commented Apr 2, 2020

XhmikosR commented Apr 29, 2020

Add a script to zip the built examples #30130

Add a script to zip the built examples #30130

Conversation

XhmikosR commented Feb 3, 2020 • edited Loading

XhmikosR commented Feb 3, 2020 via email

XhmikosR commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

MartijnCuppens commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

MartijnCuppens commented Feb 4, 2020

MartijnCuppens commented Feb 4, 2020

XhmikosR commented Feb 4, 2020

XhmikosR commented Apr 1, 2020 • edited Loading

XhmikosR Apr 1, 2020

Choose a reason for hiding this comment

MartijnCuppens commented Apr 1, 2020

XhmikosR commented Apr 1, 2020

Johann-S Apr 2, 2020

Choose a reason for hiding this comment

Johann-S Apr 2, 2020

Choose a reason for hiding this comment

XhmikosR commented Apr 2, 2020 via email

Johann-S Apr 2, 2020

Choose a reason for hiding this comment

XhmikosR commented Apr 2, 2020 via email

Johann-S commented Apr 2, 2020

XhmikosR commented Apr 2, 2020

XhmikosR commented Apr 29, 2020

XhmikosR commented Feb 3, 2020 •

edited

Loading

XhmikosR commented Apr 1, 2020 •

edited

Loading