Skip to content

Update the ml5.js example upload script to pull examples from ml5-library@main #1762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ EXAMPLE_USER_PASSWORD=hellop5js
GG_EXAMPLES_USERNAME=generativedesign
GG_EXAMPLES_EMAIL=benedikt.gross@generative-gestaltung.de
GG_EXAMPLES_PASS=generativedesign
ML5_EXAMPLES_USERNAME=ml5
ML5_EXAMPLES_EMAIL=examples@ml5js.org
ML5_EXAMPLES_PASS=helloml5
ML5_LIBRARY_USERNAME=ml5
ML5_LIBRARY_EMAIL=examples@ml5js.org
ML5_LIBRARY_PASS=helloml5
GITHUB_ID=<your-github-client-id>
GITHUB_SECRET=<your-github-client-secret>
GOOGLE_ID=<your-google-client-id> (use google+ api)
Expand Down
30 changes: 18 additions & 12 deletions server/scripts/examples-ml5.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ import rp from 'request-promise';
import Q from 'q';
import { ok } from 'assert';

// TODO: Change branchName if necessary
const branchName = 'release';
const branchName = 'main';
const branchRef = `?ref=${branchName}`;
const baseUrl = 'https://api.github.com/repos/ml5js/ml5-examples/contents';
const baseUrl = 'https://api.github.com/repos/ml5js/ml5-library/contents';
const clientId = process.env.GITHUB_ID;
const clientSecret = process.env.GITHUB_SECRET;
const editorUsername = process.env.ML5_EXAMPLES_USERNAME;
const editorUsername = process.env.ML5_LIBRARY_USERNAME;
const personalAccessToken = process.env.EDITOR_API_ACCESS_TOKEN;
const editorApiUrl = process.env.EDITOR_API_URL;
const headers = {
Expand All @@ -18,7 +17,7 @@ const headers = {

ok(clientId, 'GITHUB_ID is required');
ok(clientSecret, 'GITHUB_SECRET is required');
ok(editorUsername, 'ML5_EXAMPLES_USERNAME is required');
ok(editorUsername, 'ML5_LIBRARY_USERNAME is required');
ok(personalAccessToken, 'EDITOR_API_ACCESS_TOKEN is required');
ok(editorApiUrl, 'EDITOR_API_URL is required');

Expand Down Expand Up @@ -79,17 +78,24 @@ async function fetchFileContent(item) {
options.url !== ''
) {
file.content = await rp(options);

// NOTE: remove the URL property if there's content
// Otherwise the p5 editor will try to pull from that url
if (file.content !== null) delete file.url;

// Replace localhost references with references to the currently published version.
file.content = file.content.replace(
/http:\/\/localhost(:[0-9]+)\/ml5.js/g,
'https://unpkg.com/ml5@latest/dist/ml5.min.js'
);
}

return file;
// if it is NOT an html or js file
}

if (file.url) {
const cdnRef = `https://cdn.jsdelivr.net/gh/ml5js/ml5-examples@${branchName}${
const cdnRef = `https://cdn.jsdelivr.net/gh/ml5js/ml5-library@${branchName}${
file.url.split(branchName)[1]
}`;
file.url = cdnRef;
Expand All @@ -104,7 +110,7 @@ async function fetchFileContent(item) {
async function getCategories() {
try {
const options = Object.assign({}, githubRequestOptions);
options.url = `${options.url}/p5js${branchRef}`;
options.url = `${options.url}/examples/p5js${branchRef}`;
const results = await rp(options);

return results;
Expand All @@ -125,7 +131,7 @@ async function getCategoryExamples(sketchRootList) {
// let options = Object.assign({url: `${requestOptions.url}/${categories.path}${branchRef}`}, requestOptions)
const options = Object.assign({}, githubRequestOptions);
options.url = `${options.url}${categories.path}${branchRef}`;
// console.log(options)

const sketchDirs = await rp(options);

try {
Expand Down Expand Up @@ -158,7 +164,7 @@ async function traverseSketchTree(parentObject) {
if (parentObject.type !== 'dir') {
return output;
}
// let options = `https://api.github.com/repos/ml5js/ml5-examples/contents/${sketches.path}${branchRef}`
// let options = `https://api.github.com/repos/ml5js/ml5-library/contents/examples/p5js/${sketches.path}${branchRef}`
const options = Object.assign({}, githubRequestOptions);
options.url = `${options.url}${parentObject.path}${branchRef}`;

Expand Down Expand Up @@ -353,7 +359,7 @@ async function createProjectsInP5User(filledProjectList, user) {

/**
* MAKE
* Get all the sketches from the ml5-examples repo
* Get all the sketches from the ml5-library repo
* Get the p5 examples
* Dive down into each sketch and get all the files
* Format the sketch files to be save to the db
Expand All @@ -378,7 +384,7 @@ async function make() {

/**
* TEST - same as make except reads from file for testing purposes
* Get all the sketches from the ml5-examples repo
* Get all the sketches from the ml5-library repo
* Get the p5 examples
* Dive down into each sketch and get all the files
* Format the sketch files to be save to the db
Expand Down Expand Up @@ -414,7 +420,7 @@ async function test() {
*/

if (process.env.NODE_ENV === 'development') {
// test()
// test();
make(); // replace with test() if you don't want to run all the fetch functions over and over
} else {
make();
Expand Down