codefresh 0.88.3 → 0.88.5

package/docs/index.js

@@ -1,431 +0,0 @@
-const fs = require('fs');
-const Promise = require('bluebird');
-const recursive = Promise.promisify(require('recursive-readdir'));
-const rimraf = Promise.promisify(require('rimraf'));
-const copydir = require('copy-dir');
-const path = require('path');
-const _ = require('lodash');
-const rp = require('request-promise');
-const CFError = require('cf-errors');
-
-const TEMP_DIR = path.resolve(__dirname, '../temp');
-const TEMPLATE_DIR = path.resolve(__dirname);
-const FILES_TO_IGNORE = ['index.js', 'docs.spec.js'];
-const baseDir = path.resolve(TEMP_DIR, './content');
-const ALLOW_BETA_COMMANDS = process.env.ALLOW_BETA_COMMANDS;
-const categoriesOrder = {
-    completion: 30,
-    authentication: 31,
-    'operate on resources': 32,
-    pipelines: 40,
-    'pipelines v2 (beta)': 42,
-    projects: 45,
-    builds: 50,
-    contexts: 70,
-    images: 80,
-    triggers: 90,
-    environments: 100,
-    compositions: 110,
-    'helm repos': 111,
-    'predefined pipelines': 120,
-    'cli config': 121,
-    teams: 130,
-    more: 150,
-};
-
-
-const hasSubCommands = async (command) => {
-    const files = await recursive(path.resolve(__dirname, '../lib/interface/cli/commands'));
-
-    let hasSubCommand = false;
-    for (let j = 0; j < files.length && !hasSubCommand; j++) {
-        const file = files[j];
-
-        if (!file.endsWith('.cmd.js')) {
-            continue;
-        }
-
-        const currCommand = require(file);
-        if (_.isEqual(currCommand.parentCommand, command) && !command.isRoot()) {
-            hasSubCommand = true;
-        }
-    }
-    return hasSubCommand;
-};
-
-const getNestedCategories = async (command) => {
-    let nestedCategory = '';
-    const categoryArr = [];
-    let docs = command.prepareDocs();
-    categoryArr.push(docs.category);
-    let currCommand = command.parentCommand;
-    while (currCommand && await hasSubCommands(currCommand)) {
-        docs = currCommand.prepareDocs();
-        categoryArr.push(docs.category);
-        currCommand = currCommand.parentCommand;
-    }
-    nestedCategory = categoryArr.pop();
-    for (let i = categoryArr.length - 1; i >= 0; i--) {
-        nestedCategory = nestedCategory + '/' + categoryArr[i];
-    }
-    if (!nestedCategory) {
-        nestedCategory = command.prepareDocs().category;
-    }
-    return nestedCategory;
-};
-
-const deleteTempFolder = async () => {
-    await rimraf(TEMP_DIR);
-};
-
-const copyTemplateToTmp = async () => {
-    const filePathsToIgnore = _.map(FILES_TO_IGNORE, (file) => {
-        return path.resolve(TEMPLATE_DIR, file);
-    });
-
-    copydir.sync(TEMPLATE_DIR, TEMP_DIR, (stat, filepath) => {
-        if (stat === 'file' && filePathsToIgnore.includes(filepath)) {
-            return false;
-        } else {
-            return true;
-        }
-    });
-};
-
-/**
- * creates a specific command content and file
- * in case the file already exists in the base docs folder it will extend it
- * possible extensions are: HEADER, DESCRIPTION, COMMANDS, ARGUMENTS, OPTIONS
- */
-const getWeight = async (command) => {
-    const docs = command.prepareDocs();
-    let weight = 0;
-    if (docs.weight) {
-        return docs.weight;
-    }
-    else {
-        let parent = command.getParentCommand();
-        while (parent && !parent.prepareDocs().weight) {
-            parent = parent.getParentCommand();
-        }
-        if (parent) {
-            weight = parent.prepareDocs().weight;
-        }
-        return weight;
-    }
-};
-
-const createCommandFile = async (nestedCategory, command) => {
-    const docs = command.prepareDocs();
-    const dir = path.resolve(baseDir, `${(nestedCategory || 'undefined').toLowerCase()}`);
-
-    const commandFilePath = path.resolve(dir, `./${docs.title}.md`);
-    let finalFileString = '';
-    let skeletonFileExists = false;
-    if (fs.existsSync(commandFilePath)) {
-        finalFileString = fs.readFileSync(commandFilePath, 'utf8');
-        skeletonFileExists = true;
-    }
-
-    // HEADER STRING
-    let headerString;
-    const weight = await getWeight(command);
-    if (docs.subCategory) {
-        headerString = `+++\ntitle = "${docs.subCategory}"\nweight = ${weight || 100}\n+++\n\n`;
-    } else {
-        headerString = `+++\ntitle = "${docs.title}"\nweight = ${weight || 100}\n+++\n\n`;
-    }
-
-    if (skeletonFileExists) {
-        finalFileString = finalFileString.replace('{{HEADER}}', headerString);
-    } else {
-        finalFileString += headerString;
-    }
-
-    // DESCRIPTION STRING
-    let descriptionString = '### Description\n\n';
-    descriptionString += `${docs.description}\n\n`;
-    descriptionString += `${docs.usage}\n`;
-    if (skeletonFileExists) {
-        finalFileString = finalFileString.replace('{{DESCRIPTION}}', descriptionString);
-    } else {
-        finalFileString += descriptionString;
-    }
-
-    // COMMAND string
-    const mainCommand = docs.command.shift();
-    let commandsString = `### Command\n\`${mainCommand}\``;
-    if (docs.command.length) {
-        commandsString += `\n\n#### Aliases\n`;
-        _.forEach(docs.command, (command) => {
-            commandsString += `\n\n\`${command}\``;
-        });
-    }
-    commandsString += '\n\n';
-
-    if (skeletonFileExists) {
-        finalFileString = finalFileString.replace('{{COMMANDS}}', commandsString);
-    } else {
-        finalFileString += commandsString;
-    }
-
-    // ARGUMENTS string
-    docs.command.shift();
-    if (docs.positionals.length) {
-        const argumentsString = `### Arguments\n\nOption | Alias | Default | Description\n--------- | --------- | ----------- | -----------\n${docs.positionals}`;
-        if (skeletonFileExists) {
-            finalFileString = finalFileString.replace('{{ARGUMENTS}}', argumentsString);
-        } else {
-            finalFileString += argumentsString;
-        }
-    }
-
-    // OPTIONS string
-    if (docs.options) {
-        let optionsString = '';
-        _.forEach(docs.options, (options, group) => {
-            optionsString = `### ${group}\n\nOption | Alias | Type | Default | Description\n--------- | --------- | --------- |----------- | -----------\n${options}` + optionsString;
-        });
-        if (skeletonFileExists) {
-            finalFileString = finalFileString.replace('{{OPTIONS}}', optionsString);
-        } else {
-            finalFileString += optionsString;
-        }
-    }
-
-    // EXAMPLES string
-    if (docs.examples.length) {
-        const examplesString = `### Examples\n\n${docs.examples}`;
-        if (skeletonFileExists) {
-            finalFileString = finalFileString.replace('{{EXAMPLES}}', examplesString);
-        } else {
-            finalFileString += examplesString;
-        }
-    }
-
-    fs.writeFileSync(commandFilePath, finalFileString);
-};
-
-const createCategoryFile = async (content, category) => {
-    const indexFile = path.resolve(baseDir, `./${(category || 'undefined').toLowerCase()}/_index.md`);
-    const finalContent = content.replace('{{COMMANDS}}', '');
-    fs.writeFileSync(indexFile, finalContent);
-};
-
-/**
- * updates the category main file with a specific command
- * possible extensions are: HEADER, COMMANDS
- */
-const updateCategoryFileArray = async (nestedCategory, command, existingContent) => {
-    const docs = command.prepareDocs();
-    const { category } = docs;
-    const finalCategoryArr = existingContent || {};
-
-    // HEADER string
-    const parent = command.parentCommand;
-    let title = category;
-    if (parent) {
-        const parentdocs = parent.prepareDocs();
-        if (parentdocs.subCategory) {
-            title = parentdocs.subCategory;
-        }
-    }
-    const indexFile = path.resolve(baseDir, `./${(nestedCategory || 'undefined').toLowerCase()}/_index.md`);
-    finalCategoryArr.indexPath = indexFile;
-
-    if (!_.isEqual(title.toLowerCase(), 'more') && !_.isEqual(title.toLowerCase(), 'operate on resources')) {
-        const headerString = `+++\ntitle = "${title}"\nweight = ${categoriesOrder[title.toLowerCase()] || 100}\n+++\n\n`;
-        finalCategoryArr.header = headerString;
-    }
-    else {
-        finalCategoryArr.header = '';
-    }
-
-    let commandString = '';
-    const formattedTitle = docs.title.replace(/\s+/g, '-')
-        .toLowerCase();
-    commandString += `### [${docs.title}](${formattedTitle})\n`;
-    commandString += `\`${docs.command[0]}\`\n\n`;
-    commandString += `${docs.description}\n\n`;
-    commandString += `${docs.usage}\n\n`;
-
-    const newCmd = {};
-    finalCategoryArr.category = category;
-    newCmd.weight = await getWeight(command);
-    newCmd.content = commandString;
-    if (!finalCategoryArr.commands) {
-        finalCategoryArr.commands = [];
-
-    }
-    finalCategoryArr.commands.push(newCmd);
-
-
-    return finalCategoryArr;
-};
-
-
-/**
- * updates the category main file with a specific command
- * possible extensions are: HEADER, COMMANDS
- */
-const updateCategoryFileContent = async (finalContent) => {
-    let finalCategoryFileString = '';
-    const indexFile = finalContent.indexPath;
-    if (fs.existsSync(indexFile)) {
-        finalCategoryFileString = fs.readFileSync(indexFile, 'utf8');
-    }
-    finalCategoryFileString += finalContent.header;
-    const commandArr = finalContent.commands;
-    commandArr.sort((a, b) => {
-        return a.weight - b.weight;
-    });
-
-    _.forEach(commandArr, (command) => {
-        finalCategoryFileString += command.content;
-    });
-
-    return finalCategoryFileString;
-};
-
-const upsertCategoryFolder = async (nestedCategory) => {
-    const dir = path.resolve(baseDir, `${(nestedCategory || 'undefined').toLowerCase()}`);
-    if (!fs.existsSync(dir)) {
-        fs.mkdirSync(dir);
-    }
-};
-
-const createAutomatedDocs = async () => {
-
-    const files = await recursive(path.resolve(__dirname, '../lib/interface/cli/commands'));
-
-    const categories = {};
-    const nestedCategories = {};
-
-    for (let i = 0; i < files.length; i++) {
-        const file = files[i];
-
-        if (!file.endsWith('.cmd.js')) {
-            continue;
-        }
-
-        console.log(file);
-        const command = require(file);
-
-        // dont document beta commands currently
-        if (command.isBetaCommand() && !ALLOW_BETA_COMMANDS) {
-            continue;
-        }
-
-        // document only in case category field exists and there are no sub commands under it
-        const docs = command.prepareDocs();
-        const { category } = docs;
-        if (!category || await hasSubCommands(command)) {
-            continue;
-        }
-
-        nestedCategories[category] = await getNestedCategories(command);
-        const nestedCategory = nestedCategories[category];
-        categories[category] = await updateCategoryFileArray(nestedCategory, command, categories[category]);
-        await upsertCategoryFolder(nestedCategory);
-        await createCommandFile(nestedCategory, command);
-    }
-
-    let categoriesFinalContent = {};
-    for (let command in categories) {
-        let f = categories[command];
-        categoriesFinalContent[f.category] = await updateCategoryFileContent(f);
-    }
-
-    _.forEach(categoriesFinalContent, async (content, category) => {
-        await createCategoryFile(content, nestedCategories[category]);
-    });
-};
-
-const createDownloadPage = async () => {
-    const RequestOptions = {
-        url: 'https://api.github.com/repos/codefresh-io/cli/releases/latest',
-        headers: {
-            'User-Agent': 'codefresh-cli-build',
-        },
-        json: true,
-    };
-    try {
-        // response example https://docs.github.com/en/rest/releases/releases#get-the-latest-release
-        const { assets = [] } = await rp(RequestOptions);
-
-        const getDownloadUrlFromAssets = (nameRegex) => assets.find((a) => a.name.match(nameRegex))?.browser_download_url;
-        const downloadLinks = [
-            {
-                label: 'Alpine-x64',
-                downloadUrl: getDownloadUrlFromAssets(/alpine-x64/),
-            },
-            {
-                label: 'Linux-x64',
-                downloadUrl: getDownloadUrlFromAssets(/linux-x64/),
-            },
-            {
-                label: 'Macos-x64',
-                downloadUrl: getDownloadUrlFromAssets(/macos-x64/),
-            },
-            {
-                label: 'Windows-x64',
-                downloadUrl: getDownloadUrlFromAssets(/win-x64/),
-            },
-            {
-                label: 'Alpine-arm64',
-                downloadUrl: getDownloadUrlFromAssets(/alpine-arm64/),
-            },
-            {
-                label: 'Linux-arm64',
-                downloadUrl: getDownloadUrlFromAssets(/linux-arm64/),
-            },
-        ];
-
-        const commandFilePath = path.resolve(baseDir, './installation/download.md');
-        const finalContent =
-            '+++\n' +
-            'title = "Download"\n' +
-            'description = "asd"\n' +
-            'date = "2017-04-24T18:36:24+02:00"\n' +
-            'weight = 40\n' +
-            '+++\n' +
-            '\n' +
-            'Navigate to <a href="https://github.com/codefresh-io/cli/releases" target="_blank">Official Releases</a>\n' +
-            'and download the binary that matches your operating system.<br>\n' +
-            'We currently support the following OS: <br>\n' +
-            '<ul>\n' +
-                downloadLinks.map(({ label, downloadUrl = 'https://github.com/codefresh-io/cli/releases' }) =>
-                    `    <li><a href='${downloadUrl}' target="_blank">${label}</a></li>`).join('\n') +
-            '</ul> \n' +
-            '\n' +
-            'After downloading the binary, untar or unzip it and your are good to go.<br>\n' +
-            'You can also add the binary to your system PATH environment variable so you can use it easily.\n' +
-            '\n' +
-            'If your operating system is missing please feel free to open us an issue in our <a href="https://github.com/codefresh-io/cli/issues" target="_blank">Github repository</a>.\n';
-        fs.writeFileSync(commandFilePath, finalContent);
-    } catch (err) {
-        throw new CFError(err);
-    }
-
-};
-
-const generateDocs = async () => {
-    await deleteTempFolder();
-    await copyTemplateToTmp();
-    await createAutomatedDocs();
-    await createDownloadPage();
-};
-
-const main = async () => {
-    try {
-        await generateDocs();
-    } catch (err) {
-        console.error(err.stack);
-    }
-};
-
-if (require.main === module) {
-    main();
-} else {
-    module.exports = generateDocs;
-}

package/docs/layouts/partials/menu-footer.html

@@ -1,13 +0,0 @@
-<center>
-<!-- Place this tag where you want the button to render. -->
-<a class="github-button" href="https://github.com/codefresh-io/cli/releases" data-icon="octicon-cloud-download" aria-label="Download vjeantet/hugo-theme-docdock on GitHub">Download</a>
-
-<!-- Place this tag where you want the button to render. -->
-<a class="github-button" href="https://github.com/codefresh-io/cli" data-icon="octicon-star" data-show-count="false" aria-label="Star vjeantet/hugo-theme-docdock on GitHub">Star</a>
-
-<!-- Place this tag where you want the button to render. -->
-<a class="github-button" href="https://github.com/codefresh-io/cli/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork vjeantet/hugo-theme-docdock on GitHub">Fork</a>
-
-</center>
-<!-- Place this tag in your head or just before your close body tag. -->
-<script async defer src="https://buttons.github.io/buttons.js"></script>

package/docs/themes/docdock/LICENSE.md

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 Grav
-Copyright (c) 2016 MATHIEU CORNIC
-Copyright (c) 2017 Valere JEANTET
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/docs/themes/docdock/README.md

@@ -1,129 +0,0 @@
-# Hugo docDock Theme
-
-This repository contains a theme for [Hugo](https://gohugo.io/), based on 
-
-* [Matcornic Learn theme](https://github.com/matcornic/hugo-theme-learn/).
-* [facette.io](https://facette.io/)'s documentation style css (Facette is a great time series data visualization software)
-
-Visit the [theme documentation](http://docdock.netlify.com/) to see what is going on. It is actually built with this theme.
-
-# Main features
-
-- Search
-- **Unlimited menu levels**
-- RevealJS presentation from markdown (embededed or fullscreen page)
-- Attachments files
-- List child pages
-- Include segment of content from one page in another (Excerpt)
-- Automatic next/prev buttons to navigate through menu entries
-- Mermaid diagram
-- Icons, Buttons, Alerts, Panels, Tip/Note/Info/Warning boxes
-- Image resizing, shadow...
-- Customizable look and feel
-
-
-![Overview](https://github.com/vjeantet/hugo-theme-docdock/raw/master/images/tn.png)
-
-## Installation
-
-Check that your Hugo version is minimum `0.30` with `hugo version`. We assume that all changes to Hugo content and customizations are going to be tracked by git (GitHub, Bitbucket etc.). Develop locally, build on remote system.
-
-To start real work:
-
-1. Initialize Hugo
-2. Install DocDock theme
-3. Configure DocDock and Hugo
-
-### Prepare empty Hugo site
-
-Create empty directory, which will be root of your Hugo project. Navigate there and let Hugo to create minimal required directory structure:
-```
-$ hugo new site .
-```
-AFTER that, initialize this as git directory where to track further changes
-```
-$ git init
-```
-
-Next, there are at least three ways to install DocDock (first recommended):
-
-1. **As git submodule**
-2. As git clone
-3. As direct copy (from ZIP)
-
-Navigate to your themes folder in your Hugo site and use perform one of following scenarios.
-
-### 1. Install DocDock as git submodule
-DocDock will be added like a dependency repo to original project. When using CI tools like Netlify, Jenkins etc., submodule method is required, or you will get `theme not found` issues. Same applies when building site on remote server trough SSH.
-
-If submodule is no-go, use 3rd option.
-
-On your root of Hugo execute:
-
-```
-$ git submodule add https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock
-```
-Next initialize submodule for parent git repo:
-
-```
-$ git submodule init
-$ git submodule update
-```
-
-Now you are ready to add content and customize looks. Do not change any file inside theme directory.
-
-If you want to freeze changes to DocDock theme itself and use still submodules, fork private copy of DocDock and use that as submodule. When you are ready to update theme, just pull changes from origin to your private fork.
-
-### 2. Install DocDock simply as git clone
-This method results that files are checked out locally, but won't be visible from parent git repo. Probably you will build site locally with `hugo` command and use result from `public/` on your own.
-
-```
-$ git clone https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock
-```
-
-
-### 3. Install DocDock from ZIP
-
-All files from theme will be tracked inside parent repo, to update it, have to override files in theme. Download following zip and extract inside `themes/`.
-
-```
-https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip
-```
-Name of theme in next step will be `hugo-theme-docdock-master`, can rename as you wish.
-
-## Configure
-
-Import sample config from sample site to Hugo root.
-
-```
-$ cp themes/docdock/exampleSite/config.toml .
-```
-
-Change following `config.toml` line as needed, depending on method above:
-```
-theme = "<hugo-theme-docdock-dir-name>"
-```
-Comment out following line, so default `themes/` will be used:
-
-```
-# themesdir = "../.."
-```
-
-#### (Bonus)
-Create empty file `.gitkeep` inside `public/` and add following to `.gitignore`.  This way it will keep repo smaller and won't bring build result files and errors to remote checkout places:
-```
-/public/*
-!/public/.gitkeep
-```
-
-### Preview site
-```
-$ hugo server
-```
-to browse site on http://localhost:1313
-
-## Usage
-
-- [Visit the documentation](http://docdock.netlify.com/)
-- [Hugo docs](https://gohugo.io/getting-started/configuration/)
-- [Git submodules](https://git-scm.com/docs/git-submodule)

package/docs/themes/docdock/archetypes/default.md

@@ -1,9 +0,0 @@
-+++
-title= "{{ replace .TranslationBaseName "-" " " | title }}"
-date= {{ .Date }}
-description = ""
-draft= true
-+++
-
-Lorem Ipsum.
-Notice `draft` is set to true.

package/docs/themes/docdock/archetypes/slide.md

@@ -1,46 +0,0 @@
-+++
-title = "Slide title"
-type="slide"
-
-theme = "league"
-[revealOptions]
-transition= 'concave'
-controls= true
-progress= true
-history= true
-center= true
-+++
-
-# Slide 1
-
-___
-
-## Slide 1.1
-
-- Turn off alarm
-- Get out of bed
-
-___
-
-## Slide 1.2
-
-- Eat eggs
-- Drink coffee
-
----
-
-# Slide 2
-
-___
-
-## Slide 2.1
-
-- Eat spaghetti
-- Drink wine
-
-___
-
-## Slide 2.2
-
-- Get in bed
-- Count sheep