(follow) TO STAY UP TO DATE ON FREE & OPEN SOURCE SOFTWARE
(follow) TO GET ONE DEV MINUTE DAILY HOT TIPS & TROLLS
(subscribe) TO TECH TALKS & ONE DEV MINUTE VIDEOS
(read) MOSTLY LONG FORM TECHNICAL ARTICLES
(connect) WITH THE LINKEDIN PROFILE Y'ALL
(follow) To stay up to date on free & open-source software
(follow) To get #OneDevMinute daily hot tips & trolls
(subscribe) To tech talks & #OneDevMinute videos
(read) In-depth & long form technical articles
(connect) On the LinkedIn profile y'all
================================================
FILE: template/assets.yml
================================================
name: "👌 IMPROVE: Assets or readme"
on:
push:
branches:
- master
jobs:
master:
name: "build"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: WordPress.org plugin asset/readme update
uses: 10up/action-wordpress-plugin-asset-update@master
env:
GITHUB_TOKEN: ${{{{raw-helper}}}}{{ secrets.GITHUB_TOKEN }}{{{{/raw-helper}}}}
SVN_USERNAME: ${{{{raw-helper}}}}{{ secrets.SVN_USERNAME }}{{{{/raw-helper}}}}
SVN_PASSWORD: ${{{{raw-helper}}}}{{ secrets.SVN_PASSWORD }}{{{{/raw-helper}}}}
SLUG: "{{slug}}"
================================================
FILE: template/release.yml
================================================
name: "🚀 RELEASE: To WordPress.org"
on:
push:
tags:
- "*"
jobs:
tag:
name: "build"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: WordPress Plugin Deploy
uses: 10up/action-wordpress-plugin-deploy@master
env:
GITHUB_TOKEN: ${{{{raw-helper}}}}{{ secrets.GITHUB_TOKEN }}{{{{/raw-helper}}}}
SVN_USERNAME: ${{{{raw-helper}}}}{{ secrets.SVN_USERNAME }}{{{{/raw-helper}}}}
SVN_PASSWORD: ${{{{raw-helper}}}}{{ secrets.SVN_PASSWORD }}{{{{/raw-helper}}}}
SLUG: "{{slug}}"
================================================
FILE: test.js
================================================
const wpContinuousDeployment = require('./index.js');
wpContinuousDeployment();
================================================
FILE: utils/downloadAssets.js
================================================
const path = require("path");
const chalk = require("chalk");
const axios = require("axios");
const green = chalk.bold.green;
const yellow = chalk.bold.yellow;
const arrify = require("arrify");
const getUrls = require("get-urls");
const download = require("download");
const to = require("await-to-js").default;
const logSymbols = require("log-symbols");
const handleError = require("./handleError.js");
const isDirEmpty = require("is-dir-empty");
const dest = path.resolve(process.cwd(), "./.wordpress-org/");
module.exports = async (slug, spinner) => {
spinner.start(`${yellow(`ASSETS`)} finding…`);
const url = `https://ps.w.org/${slug}/assets/`;
const [errRes, res] = await to(axios.get(url));
// handleError("FAILED ON ASSETS", errRes); // Not needed.
if (errRes) {
spinner.warn(`${yellow(`No ASSETS`)} found`);
} else {
const urlData = res.data.replace(
/href="/g,
`href="https://ps.w.org/${slug}/assets/`
);
const getLinks = arrify(getUrls(urlData));
// Remove the first and last.
const buildLinks = getLinks.slice(1, getLinks.length - 1);
// Remove the languages link.
const links = buildLinks.filter(
link => link !== `https://ps.w.org/${slug}/assets/languages`
);
spinner.succeed(
`${green(`ASSETS`)} found ${links.length} asset${
links.length > 1 ? `s` : ``
}`
);
spinner.start(`${yellow(`ASSETS`)} downloading…`);
const [errDown, down] = await to(
Promise.all(
links.map(async (link, i) => {
await download(link, dest);
spinner.start(
`${yellow(`ASSETS`)} downloading ${i + 1}/${links.length}…`
);
})
)
);
handleError("FAILED ON FILE DOWNLOADS", errDown);
spinner.succeed(
`${green(`ASSETS`)} downloaded ${links.length}/${links.length}`
);
}
// Check if assets were downloaded.
const isEmpty = await isDirEmpty(dest);
// Return true if not empty.
return !isEmpty;
};
================================================
FILE: utils/exitClone.js
================================================
const logSymbols = require("log-symbols");
const chalk = require("chalk");
const green = chalk.bold.green;
const red = chalk.bold.red;
const yellow = chalk.bold.yellow;
module.exports = clone => {
if (!clone) {
console.log(`${red(`${logSymbols.error} Nops. You're doing it wrong.`)}`);
console.log(
yellow(`
${logSymbols.info} Follow these steps:
1. Put your WordPress plugin on GitHub (https://repo.new)
2. Clone the GitHub repo in your PC and browse it with command line
3. Run ${green(
`npx wp-console-deployment`
)} in the root directory of the cloned repo
`)
);
process.exit(0);
}
};
================================================
FILE: utils/finishLine.js
================================================
const chalk = require("chalk");
const logSymbols = require("log-symbols");
const dim = chalk.dim;
const green = chalk.bold.green;
const yellow = chalk.bold.yellow;
// Final notice.
module.exports = (slug, url, hasAssets) => {
console.log(
`${logSymbols.success} ${green(`…and that was it.`)} ${yellow(
`Wait, a couple more things to set up`
)}`
);
console.log(`\n${logSymbols.info} ${yellow(`One-time setup:`)}
Remember the username and password you use at https://login.WordPress.org
❯❯ Go to ${dim(`${url}/settings/secrets`)}
1. Click "Add New Secret" add name ${green(
`SVN_USERNAME`
)} and fill the value with your username
2. Click "Add New Secret" again; add name ${green(
`SVN_PASSWORD`
)} and fill the value with your password`);
console.log(`\n${logSymbols.success} ${green(`Now what?!`)}`);
if (!hasAssets) {
console.log(
`- Make sure all plugin assets were downloaded to the ${green(
`.wordpress-org`
)} directory\n- Or manually download from ${dim(
`https://ps.w.org/${slug}/`
)} (if exists) ${dim(`assets`)} directory`
);
}
console.log(`- Now for each commit/push to master your assets & readme will get deployed
- And for each new tag/push a new version of plugin will be deployed
- So, go ahead, make change, git commit, and then run:
${green(`git tag 2.0.0 && git push --tags`)}
${dim(`# Considering 2.0.0 is the new version`)}
`);
};
================================================
FILE: utils/handleError.js
================================================
const ora = require("ora");
const chalk = require("chalk");
const red = chalk.bold.red;
const yellow = chalk.bold.yellow;
const spinner = ora({ text: "" });
module.exports = (heading, err, displayError = true, exit = true) => {
if (err) {
console.log();
if (displayError) {
spinner.fail(`${red(heading)}`);
spinner.fail(`${red(`ERROR →`)} ${err.name}`);
spinner.fail(`${red(`REASON →`)} ${err.message}`);
spinner.fail(`${red(`ERROR STACK ↓ \n`)} ${err.stack}\n`);
} else {
spinner.warn(`${yellow(heading)}`);
}
if (exit) {
process.exit(0);
} else {
return false;
}
}
};
================================================
FILE: utils/handleTemplate.js
================================================
const fs = require("fs");
const path = require("path");
const makeDir = require("make-dir");
const handlebars = require("handlebars");
handlebars.registerHelper("raw-helper", options => options.fn());
module.exports = async slug => {
const files = [`assets`, `release`];
for (file of files) {
const fileContents = fs.readFileSync(
path.join(__dirname, `./../template/${file}.yml`),
`utf8`
);
const source = fileContents.toString();
const template = handlebars.compile(source);
const rendered = template({ slug });
await makeDir(`./.github/workflows/`);
await makeDir(`./.wordpress-org/`);
const done = fs.writeFileSync(
`./.github/workflows/${file}.yml`,
rendered,
`utf8`
);
}
};
================================================
FILE: utils/query.js
================================================
const shouldCancel = require("./shouldCancel.js");
export default (question, type) => {
const query = new Toggle(question);
const [err, res] = await to(query.run());
handleError(type, err);
await shouldCancel(res);
};
================================================
FILE: utils/sbx.js
================================================
#!/usr/bin/env node
// Makes the script crash on unhandled rejections instead of silently
// ignoring them. In the future, promise rejections that are not handled will
// terminate the Node.js process with a non-zero exit code.
process.on("unhandledRejection", err => {
console.log("err", err);
});
const clearConsole = require("clear-any-console");
(async () => {
clearConsole();
})();
================================================
FILE: utils/shouldCancel.js
================================================
const chalk = require("chalk");
const yellow = chalk.bold.yellow;
// Exit gracefully if user trying to cancel.
module.exports = async action => {
if (action === undefined) {
console.log(yellow(`❯ Cancelled!\n`));
process.exit(0);
}
};
================================================
FILE: utils/welcome.js
================================================
const pkg = require("./../package.json");
const welcome = require("cli-welcome");
module.exports = () => {
// Use it.
welcome(
`WP Continuous Deployment`,
`
by Awais.dev 👋`,
{
bgColor: `#d54e21`,
color: `#000000`,
bold: true,
clear: true,
version: `v${pkg.version}`
}
);
};
