GithubHelp home page GithubHelp logo

vardot / vardoc-project Goto Github PK

View Code? Open in Web Editor NEW
4.0 6.0 4.0 1.06 MB

Project template for Vardoc distribution

Home Page: https://www.drupal.org/project/vardoc

License: GNU General Public License v2.0

knowledge base documen documentation varbase drupal drupal-8 docman knowledge-based-systems manual

vardoc-project's Introduction

Vardot Vardoc 4.0.9

Vardoc Project

Project template for Vardoc distribution.

Create a Vardoc project with Composer:

Install with Composer

To install the most recent stable release of Vardoc run this command:

composer create-project vardot/vardoc-project:~4 PROJECT_DIR_NAME --no-dev --no-interaction

To install the dev version of Vardoc 4.0.x-dev run this command:

composer create-project vardot/vardoc-project:4.0.x-dev PROJECT_DIR_NAME --stability dev --no-interaction

Built using Varbase, the base distribution delivered to you by Vardot

This distribution is sponsored and developed by Vardot. Initial building, ongoing maintenance and development.

vardoc-project's People

Contributors

natshah avatar oalahmed avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

vardoc-project's Issues

Drop support for Composer ~1.0 in the Vardoc Project template and only support Composer ~2.0 and later versions

Problem/Motivation

Having mixed composer requirements opens the way to get older plugins and libraries
This brings a number of issues to new builds and the autoloader.
#3301450: Have drupal-scaffold locations web-root for Vardoc as docroot to fix composer web-root folder in projects
#3301451: Have drupal-scaffold locations web-root for Varbase as docroot to fix composer web-root folder in projects
#3302442: Drop support for Composer ~1.0 in Varbase profile and only support Composer ~2.0 and later versions

Proposed resolution

Ditch the support for Composer ~1.0 and older plugins and libraries
Support Composer ~2.0 and later versions ( ~2.1.0, ~2.2.0, ~2.3.0 )

Have drupal-scaffold locations web-root for Vardoc Project template as docroot to fix composer web-root folder in projects

Problem/Motivation

Composer is fixed to docroot folder and should use web-root such as core composer to let use this project into custom folder.

Steps to reproduce

Having issues with custom composer build with Vardoc profile conflicting with changes over Vardoc Project template
When changed in projects, composer will face issues on builds and updates

Proposed resolution

Double-check what Drupal Recommended Project is doing
https://github.com/drupal/recommended-project/blob/9.4.5/composer.json#L43
Use the right web-root in both Vardoc profile and Vardoc Project template

    "drupal-scaffold": {
      "allowed-packages": [
        "drupal/core",
        "vardot/varbase",
        "vardot/vardoc"
      ],
      "gitignore": true,
      "locations": {
        "web-root": "./docroot"
      },
      "file-mapping": {
        "[web-root]/sites/default/default.services.yml": {
          "mode": "replace",
          "overwrite": false,
          "path": "docroot/core/assets/scaffold/files/default.services.yml"
        },
        "[web-root]/sites/default/default.settings.php": {
          "mode": "replace",
          "overwrite": false,
          "path": "docroot/core/assets/scaffold/files/default.settings.php"
        },
        "[web-root]/robots.txt": {
          "append": "docroot/profiles/varbase/src/assets/varbase-robots-additions.txt"
        }
      }
    },

Projects could change "web-root": "docroot/" and docroot to web using change or a clone of the Vardoc Project Template

Patch applying problem

I run:
composer create-project Vardot/vardoc-project:^8.2.2 vardoc --no-dev --no-interaction
and after time I've got:

  • Installing easyrdf/easyrdf (0.9.1): Loading from cache

[Exception]
Cannot apply patch Issue #2869592: Disabled update module shouldn't produce a status report warning (https://www.drupal.org/files/issues/2869592-remove-update-warning-
7.patch)!

create-project [-s|--stability STABILITY] [--prefer-source] [--prefer-dist] [--repository REPOSITORY] [--repository-url REPOSITORY-URL] [--dev] [--no-dev] [--no-custom-installers] [--no-scripts] [--no-progress] [--no-secure-http] [--keep-vcs] [--remove-vcs] [--no-install] [--ignore-platform-reqs] [--] [] [] []

Add composer allow-plugins to composer.json for Vardoc and Vardoc Project template

Issue #3255863: Add composer allow-plugins to composer.json for Vardoc and Vardoc Project template
https://www.drupal.org/project/vardoc/issues/3256732

Composer 2.2.1 was released 2021-12-22
https://getcomposer.org/changelog/2.2.1
https://github.com/composer/composer/releases/tag/2.2.1

  • Fixed plugin autoloading including files autoload rules from the root package (#10382)
  • Fixed issue parsing php files with unterminated comments found inside backticks (#10385)

https://getcomposer.org/doc/06-config.md#allow-plugins

After updating the composer in local or in an automated testing you will face the following issue

composer/installers contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins
Do you trust "composer/installers" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?] y
y - add package to allow-plugins in composer.json and let it run immediately
n - add package (as disallowed) to allow-plugins in composer.json to suppress further prompts
d - discard this, do not change composer.json and do not allow the plugin to run
? - print help

A question to trust will show up for each used composer plugin in Vardoc

Do you trust "composer/installers" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?] y
cweagans/composer-patches contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins
Do you trust "cweagans/composer-patches" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?] y
oomphinc/composer-installers-extender contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins
Do you trust "oomphinc/composer-installers-extender" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?] y
drupal/core-composer-scaffold contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins
Do you trust "drupal/core-composer-scaffold" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?] y
drupal/core-project-message contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins
Do you trust "drupal/core-project-message" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?] y
vardot/varbase-updater contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins
Do you trust "vardot/varbase-updater" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?] y
dealerdirect/phpcodesniffer-composer-installer (installed globally) contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins
dealerdirect/phpcodesniffer-composer-installer (installed globally) contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins
Do you trust "dealerdirect/phpcodesniffer-composer-installer" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?] y

Proposed resolution

Adding allow-plugins to Vardoc and Vardoc Project template
Not to block builds or updates.

  "config": {
    "bin-dir": "bin/",
    "secure-http": false,
    "optimize-autoloader": true,
    "preferred-install": {
      "drupal/core": "dist"
    },
    "allow-plugins": {
      "composer/installers": true,
      "cweagans/composer-patches": true,
      "oomphinc/composer-installers-extender": true,
      "drupal/core-composer-scaffold": true,
      "drupal/core-project-message": true,
      "vardot/varbase-updater": true
    }
  },

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.