Skip to content

Commit

Permalink
[SDPA-633] Make SDP Repositories Public (#4)
Browse files Browse the repository at this point in the history
* Remove composer.json from git attributes

* Fix Circle CI, update readme

* Add GPL 2 license

* Update Readme and change composer.dev.json for CircleCI dependency in modules

* Update composer.dev tide definition to use github api

* Update definition of tide API

* Update definition of tide API

* Update definition of tide core

* Update definition of tide_* modules
enzolutions authored Aug 29, 2018

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 7892fc1 commit 7aaac81
Showing 4 changed files with 355 additions and 291 deletions.
9 changes: 0 additions & 9 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
version: 2
aliases:
# SSH key fingerprint to deploy code. Add private key of the user who is
# allowed to push to $DEPLOY_REMOTE repo under "SSH Permissions" in
# CircleCI UI.
- &ssh_key_fingerprint "36:03:e3:ca:b3:0b:82:18:e2:e9:ae:5d:81:17:86:b1"

- &build
working_directory: /app
docker:
- image: singledigital/bay-circle:latest
environment: &environment
SSH_KEY_FINGERPRINT: *ssh_key_fingerprint
COMPOSER_ALLOW_SUPERUSER: 1
COMPOSE_PROJECT_NAME: mysite
COMPOSE_FILE: docker-compose.yml
@@ -23,9 +18,6 @@ aliases:
- setup_remote_docker:
docker_layer_caching: true
version: 17.06.0-ce
- add_ssh_keys:
fingerprints:
- *ssh_key_fingerprint
- run:
name: Composer validate
# @dev
@@ -45,7 +37,6 @@ aliases:
- run:
name: Configure SSH for CLI container
command: |
SSH_KEY_FILE="${SSH_KEY_FINGERPRINT//:}" && SSH_KEY_FILE="id_rsa_${SSH_KEY_FILE//\"}" && export $SSH_KEY_FILE
docker-compose exec cli bash -c 'rm /home/.ssh/*'
docker cp -L ~/.ssh/$SSH_KEY_FILE $(docker-compose ps -q cli):/home/.ssh/key
- run:
339 changes: 339 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

Preamble

The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.

When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.

We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.

Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and
modification follow.

GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.

1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.

You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.

2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:

a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.

b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.

c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.

In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.

3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:

a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,

b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,

c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.

If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.

4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.

5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.

6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.

7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.

It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.

This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.

8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.

9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.

10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.

NO WARRANTY

11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.

12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.

<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice

This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
274 changes: 4 additions & 270 deletions README.md
Original file line number Diff line number Diff line change
@@ -3,6 +3,10 @@ Tide is a Drupal 8 distribution focused on delivering an API first, headless Dru

[![CircleCI](https://circleci.com/gh/dpc-sdp/tide.svg?style=svg&circle-token=2725c08f9f9c81b430b5c302d4843b20b8deec86)](https://circleci.com/gh/dpc-sdp/tide)

# Caveats

Tide is on the alpha release, use with caution. APIs are likely to change before the stable version, that there will be breaking changes and that we're not supporting it for external production sites at the moment.

## Tide modules
- [tide_api](https://github.com/dpc-sdp/tide_api)
- [tide_core](https://github.com/dpc-sdp/tide_core)
@@ -22,10 +26,6 @@ Tide is a Drupal 8 distribution focused on delivering an API first, headless Dru
* Requirements
* Recommended Modules
* Installation
* Configuration
* Troubleshooting
* FAQ
* Maintainers

# INTRODUCTION
The Tide distribution has been developed as a part of the Single Digital Presence project from the Department of Premier and Cabinet in Victoria. For further information visit the Single Digital Presence website, https://sdp.vic.gov.au, The github project page, https://github.com/dpc-sdp/tide or the Drupal project page, https://drupal.org/project/tide. Tide utilises a number of SDP specific modules with the `tide_` prefix, providing a range of functionality designed speficically for the State Government of Victoria Australia.
@@ -42,81 +42,6 @@ For further information visit the Single Digital Presence website, https://sdp.v
* cweagans/composer-patches
* drupal-composer/drupal-scaffold

# DEVELOPMENT SETUP
The SDP project also provides the Bay hosting platform, https://github.com/dpc-sdp/bay, which all SDP projects are designed to be hosted on, however, this is not a restriction and all SDP projects can be run in any similar hosting environment.

Take a look at the CONFIGURATION section below for some useful tools.

The Bay configuration files are provided as the default for local development. At a minimum, the following tools are required to use this configuration:
1. Docker for Mac - https://www.docker.com/docker-mac
1. Composer
1. Pygmy

You can install these tools manually, or using Homebrew with these instructions:

## LOCAL TOOLS SETUP
1. Install [Homebrew](https://brew.sh/)
```bash
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
1. Install Docker
```bash
brew cask install docker
```
1. Start docker and you should be able to run:
```bash
docker ps
```
1. Install pygmy
```bash
gem install pygmy
```
1. Install Composer
```bash
brew bundle
brew install composer
```

## SETUP YOUR LOCAL PROJECT
3. Checkout project repo and confirm the path is in docker's file sharing config - https://docs.docker.com/docker-for-mac/#file-sharing
5. Make sure you don't have anything running on port 80 on the host machine (like a web server) then run
```bash
pygmy up
```
6. Run
```bash
composer app:build
```
7. Once build has completed, you can run
```bash
composer app:login
```
to
```bash
drush uli
```
into the local site.

* _*NOTE:*_ If any steps fail, you're safe to rerun from any point,
starting again from the beginning will just reconfirm the changes.
# RECOMMENDED MODULES
THe Tide distribution will automatically install all of the tide_* modules.
* tide_api - https://github.com/dpc-sdp/tide_api
* tide_core - https://github.com/dpc-sdp/tide_core
* tide_landing_page - https://github.com/dpc-sdp/tide_landing_page
* tide_media - https://github.com/dpc-sdp/tide_media
* tide_monsido - https://github.com/dpc-sdp/tide_monsido
* tide_news - https://github.com/dpc-sdp/tide_news
* tide_page - https://github.com/dpc-sdp/tide_page
* tide_search - https://github.com/dpc-sdp/tide_search
* tide_search_core - https://github.com/dpc-sdp/tide_search_core
* tide_site - https://github.com/dpc-sdp/tide_site
* tide_test - https://github.com/dpc-sdp/tide_test
* tide_webform - https://github.com/dpc-sdp/tide_webform
# INSTALLATION
Include the Tide distribution in your composer.json file
```bash
@@ -127,194 +52,3 @@ Install your site using the distribution
drush si tide
```

# CONFIGURATION
The Tide distribution is very light and offer minimal code. The functionality is provided within the included tide_* modules. The distribution is mainly used to collate the full suite of modules for easy installation of a site, mirroring the full SDP project sites.
## USEFUL COMMANDS
The following composer commands are provided in this distributions composer.json file. To access them in your project you'll need to manually copy them to your root composer.json file for your project.

**Application**
- `composer app:build` - build application and local development environment.
- `composer app:rebuild` - rebuild application and local development environment with removing all dependencies.
- `composer app:cleanup` - remove all dependencies.
- `composer app:login` - login into locally built website (run `drush uli` on the `cli` container).
- `composer app:test` - run tests.
- `composer app:cs` - lint code.
- `composer app:cr` - rebuild application cache.
- `composer app:drush` - run drush commands. Example: `composer app:drush -- status`
- `composer app:site-install` - run site installation from profile.
- `composer app:db-import` - download and re-import DB.

**Bay**
- `composer bay:start` - build and start local development environment.
- `composer bay:restart` - restart local development environment.
- `composer bay:stop` - stop all Bay containers.
- `composer bay:destroy` - stop and remove all Bay containers.
- `composer bay:doctor` - helps to find the cause of any issues with a local setup.
- `composer bay:logs` - get logs from all running Bay containers.
- `composer bay:cli` - run a command in `cli` container. Example: `composer bay:cli -- ls -al`.
- `composer bay:pull` - pull latest Bay containers.

## Logs.

Using the composer helper script you can get logs from any running container.

`composer bay:logs`

You can also filter the output to show only logs from a particular service.
For example `composer bay:logs -- php` will show the log output from the php container.
The full list of services can be found in the `docker-compose.yml`

## SSHing into CLI container

`docker-compose exec cli bash`


## Mailhog.

Mailhog is included with `pygmy` and is available @ http://mailhog.docker.amazee.io/
Documentation for mailhog is available of the project page -- https://github.com/mailhog/MailHog

## Stage file proxy.

Stage File Proxy is enabled on all non production environments so files are automatically downloaded directly from prod on demand.

## Debugging

### PHP application from browser
1. Trigger xDebug from web browser (using one of the browser extensions) so that PHPStorm recognises the server `content-vicgovau.docker.amazee.io` and configures the path mapping. Alternatively, you can create the server in PHPStorm Settings.
* Make sure `serverName` to be `content-vicgovau.docker.amazee.io`


### PHP scripts
1. Make sure `scripts/xdebug.sh` is executable.
2. SSH into CLI container: `docker-compose exec cli bash`
3. Run your PHP script: `scripts/xdebug.sh path/to/script`.
* Example running a single Behat test: `scripts/xdebug.sh vendor/bin/behat path/to/test.feature`

### Drush commands
3. To debug `drush` commands:
* SSH to CLI container: `docker-compose exec cli bash`
+ `cd docroot`
+ `../scripts/xdebug.sh ../vendor/bin/drush <DRUSH_COMMAND>`
- Example: `../scripts/xdebug.sh ../vendor/bin/drush updb -y`
* Debug directly from host machine: `composer debug-drush -- <DRUSH_COMMAND>`
+ Example: `composer app:debug-drush -- updb -y`

### DB connection details

```
Host: 127.0.0.1
Username: drupal
Password: drupal
Database: drupal
Port: 13306
```
### Pre deployment database backups
An automatic backup of the production database is taken before any new deployment.
This is currently stored in the private files directory and overridden on each deployment.
#### Restoring a backup
1. Access production `cli` container on Bay.
2. Take a backup of failed deployment db for debugging.
`drush sql-dump --gzip --result-file=/app/docroot/sites/default/files/private/failed_deployment.sql`
3. Import pre-deployment backup.
`gzip -cd /app/docroot/sites/default/files/private/pre_deploy_backup.sql.gz | drush sqlc`
4. Clear cache.
`drush cr`
# TROUBLESHOOTING/FAQ
## Adding Drupal modules
Modules needs to be added in 2 steps:
1. Require module code installation (through composer).
2. Enable module during site installation.
### Step 1. Adding contrib modules
`composer require drupal/module_name`
or for specific versions
`composer require drupal/module_name:1.2`
OR
### Step 1. Adding modules as local packages
1. Add local package information to root `composer.json`:
```
"repositories": {
"dpc-sdp/tide_page": {
"type": "path",
"url": "dpc-sdp/tide_page"
},
}
```
2. Assess if package is required for distribution (Tide) or site (content.vic.gov.au) and add to relevant `composer.json`:
- for distribution - `dpc-sdp/tide/composer.json`
- for site - `composer.json`
3. To make sure that composer trigger dependency tree rebuild, run `composer app:cleanup`.
4. Run `composer update --lock`. This will install all dependencies and update root `composer.lock` file with newly added module.
### Step 2. Enable module
1. Assess if module is a part of distribution or site-specific and add to appropriate `info.yml` file:
- for distribution - `dpc-sdp/tide/tide.info.yml`
- for site - `docroot/modules/custom/vicgovau_core/vicgovau_core.info.yml`
If module is a dev-only module (required to be enabled for development only),
use `vicgovau_core_install()` in `docroot/modules/custom/vicgovau_core/vicgovau_core.install` to enable it programmatically. This is required as we are using site install and not storing exported configuration.
## Adding patches for drupal modules
1. Add `title` and `url` to patch on drupal.org to the `patches` array in `extra` section in `composer.json`.
```
"extra": {
"patches": {
"drupal/core": {
"Contextual links should not be added inside another link - https://www.drupal.org/node/2898875": "https://www.drupal.org/files/issues/contextual_links_should-2898875-3.patch"
}
}
}
```
2. `composer update --lock`
## Coding standards
PHP and JS code linting uses [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) with Drupal rules from [Coder](https://www.drupal.org/project/coder) module and additional local overrides in `phpcs.xml.dist` and `.eslintrc`.
## Behat tests
Behat configuration uses multiple extensions:
- [Drupal Behat Extension](https://github.com/jhedstrom/drupalextension) - Drupal integration layer. Allows to work with Drupal API from within step definitions.
- [Behat Screenshot Extension](https://github.com/integratedexperts/behat-screenshot) - Behat extension and a step definition to create HTML and image screenshots on demand or test fail.
- [Behat Progress Fail Output Extension](https://github.com/integratedexperts/behat-format-progress-fail) - Behat output formatter to show progress as TAP and fail messages inline. Useful to get feedback about failed tests while continuing test run.
- `VicgovauDrupalContext` - Site-specific Drupal context with custom step definitions.
- `VicgovauMinkContext` - Site-specific Mink context with custom step definitions.
Generic Behat tests should be written against the test entities from the Tide Test module. If a new test entity (node, block, etc.) is added to the Tide Test module, the relevant permissions must be also granted to Approver and Editor via the hook `tide_test_entity_bundle_create()`.
### Run tests locally:
- Run all tests: `composer app:test`
- Run PHPUnit tests: `composer app:test-phpunit`
- Run Behat tests: `composer app:test-behat`
- Run specific test feature: `composer app:test-behat tests/behat/features/homepage.feature`
- Run specific test tag: `composer app:test-behat -- --tags=wip`
Read more information in [the wiki page](https://digital-engagement.atlassian.net/wiki/spaces/SDP/pages/134906009/Behat+testing).
## Automated builds (Continuous Integration)
In software engineering, continuous integration (CI) is the practice of merging all developer working copies to a shared mainline several times a day.
Before feature changes can be merged into a shared mainline, a complete build must run and pass all tests on CI server.
This project uses [Circle CI](https://circleci.com/) as CI server: it imports production backups into fully built codebase and runs code linting and tests. When tests pass, a deployment process is triggered for nominated branches (usually, `master` and `develop`).
Add [skip ci] to the commit subject to skip CI build. Useful for documentation changes.
### SSH
Circle CI supports SSHing into the build for 30 minutes after the build is finished. SSH can be enabled either during the build run or when the build is started with SSH support.
### Cache
Circle CI supports caching between builds. The cache takes care of saving the state of your dependencies between builds, therefore making the builds run faster.
Each branch of your project will have a separate cache. If it is the very first build for a branch, the cache from the default branch on GitHub (normally `master`) will be used. If there is no cache for master, the cache from other branches will be used.
If the build has inconsistent results (build fails in CI but passes locally), try to re-running the build without cache by clicking 'Rebuild without cache' button.
### Test artifacts
Test artifacts (screenshots etc.) are available under 'Artifacts' tab in Circle CI UI.
24 changes: 12 additions & 12 deletions composer.dev.json
Original file line number Diff line number Diff line change
@@ -36,62 +36,62 @@
"dpc-sdp/tide": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide.git"
"url": "git@github.com:dpc-sdp/tide.git"
},
"dpc-sdp/tide_api": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_api.git"
"url": "git@github.com:dpc-sdp/tide_api.git"
},
"dpc-sdp/tide_core": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_core.git"
"url": "git@github.com:dpc-sdp/tide_core.git"
},
"dpc-sdp/tide_landing_page": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_landing_page.git"
"url": "git@github.com:dpc-sdp/tide_landing_page.git"
},
"dpc-sdp/tide_media": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_media.git"
"url": "git@github.com:dpc-sdp/tide_media.git"
},
"dpc-sdp/tide_monsido": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_monsido.git"
"url": "git@github.com:dpc-sdp/tide_monsido.git"
},
"dpc-sdp/tide_news": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_news.git"
"url": "git@github.com:dpc-sdp/tide_news.git"
},
"dpc-sdp/tide_page": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_page.git"
"url": "git@github.com:dpc-sdp/tide_page.git"
},
"dpc-sdp/tide_search": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_search.git"
"url": "git@github.com:dpc-sdp/tide_search.git"
},
"dpc-sdp/tide_site": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_site.git"
"url": "git@github.com:dpc-sdp/tide_site.git"
},
"dpc-sdp/tide_test": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_test.git"
"url": "git@github.com:dpc-sdp/tide_test.git"
},
"dpc-sdp/tide_webform": {
"type": "vcs",
"no-api": true,
"url": "ssh://git@github.com:22/dpc-sdp/tide_webform.git"
"url": "git@github.com:dpc-sdp/tide_webform.git"
},
"library/dropzone": {
"type": "package",

0 comments on commit 7aaac81

Please sign in to comment.