• This repository has been archived on 06/Dec/2022
  • Stars
    star
    113
  • Rank 310,115 (Top 7 %)
  • Language
    PHP
  • License
    GNU General Publi...
  • Created over 9 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Current stable release of the main Drupal 7 GovCMS distribution, with releases mirrored at https://www.drupal.org/project/govcms

govCMS

CircleCI

Note: This release is not Acquia specific. Please continue to use 2.x release if you are in Acquia.

Installation

Packaged installation

govCMS exists as packaged versions on both the Github and Drupal.org project pages. These compressed archives are available in both zip and tar.gz format to download and use as needed.

Local development environment setup

  1. Make sure that you have Docker, Pygmy and Ahoyinstalled.
  2. Checkout project repository git clone [email protected]:govCMS/govCMS.git
  3. ahoy up
  4. ahoy make
  5. ahoy install
  6. http://govcms.docker.amazee.io

This will construct a copy of the govCMS Drupal codebase in the docroot directory using instructions from the govcms.make file.

Once built, the profile files will be symlinked into /app/profiles/govcms.

List of available Ahoy workflow commands:

   build        Build project.
   cli          Start a shell inside CLI container.
   drush        Run drush commands in the CLI service container.
   install      Install the profile.
   lint         Lint code
   login        Login to a website.
   logs         Show Docker logs.
   make         Install local dependencies.
   ps           List running Docker containers.
   pull         Pull latest docker images.
   push         Push all docker images.
   release      Push all docker images.
   restart      Restart Docker containers.
   run          Run command inside CLI container.
   stop         Stop Docker containers.
   test         Run all tests.
   test-behat   Run behat tests.
   test-phpunit Run phpunit tests.
   up           Build project.

Structure

General

  • docroot - The Drupal root. This can be either a directory or a symlink.
  • README.md - Project documentation written in markdown.
  • composer.json - Project specific vendor packages and repositories.
  • composer.lock - Locked in version of vendor packages. To ensure consistency across the project.
  • .gitignore - A list of files to be ignored by git. This is typically used for excluding local development modules and may create files to ignore that an IDE creates.

Behat

  • behat.yml - Provides all project specific behat configuration. Including regions and context configuration.
  • tests/behat - The directory where behat *.feature files are stored.

The ability to test a govCMS build is built into the repository with all tests run by Circle CI able to be run locally. Any changes made should be added and committed to your local repository and the following commands run:

ahoy test-behat
ahoy test-phpunit

Individual tests may be run by specifying the target for commands:

ahoy test-behat -- tests/behat/features/home.feature

Debugging CLI

To debug CLI commands, such as Behat tests, using XDEBUG:

  1. ahoy cli to get into test container.
  2. cd tests/behat
  3. . xdebug.sh ../../vendor/bin/behat path/to/test.feature

Patching govCMS

Because govCMS is a Drupal distribution, modules and configurations are not added directly to the codebase. Rather, they are referenced within the govcms.make file.

Any alterations to Drupal core or contributed modules must have an associated drupal.org issue filed against the project in question. Modifications should be made directly to the project in question and patched into govCMS rather than made directly against govCMS.

It is a requirement for any patches to govCMS to pass all automated testing prior to manual review. The automated testing checks for PHP syntax, coding standards, build completion and runs behavioural tests. It is also desirable that additions to the codebase add behat tests to ensure no regressions occur once committed.

To submit a patch, the govCMS project should be forked and changes applied to a branch on the forked repository. Once all changes are applied, a pull request between govCMS/master and the branch of the fork may be created.

Releasing govCMS

See RELEASE.md

Contributing to govCMS

All contributions to govCMS are welcome. Issues and pull requests may be submitted against the govCMS project on github where they will be addressed by the govCMS team.

More information may be found in CONTRIBUTING.md.

More Repositories

1

GovCMS

Current Drupal9 release of the main GovCMS distribution, with releases mirrored at https://www.drupal.org/project/govcms
PHP
85
star
2

GovCMS8

Current stable release of the main GovCMS8 distribution.
PHP
61
star
3

lagoon

GovCMS Lagoon project
PHP
15
star
4

govcms8_uikit_starter

GovCMS 8 UI-Kit Starter
HTML
10
star
5

govcms-ckan

A Drupal 7 module to integrate with CKAN datasources such as data.gov.au and create visualisations
PHP
7
star
6

scaffold-tooling

Shell
6
star
7

GovCMS8-project

Composer based installer for govCMS8 (stable), intended for end-user/theme developer installation of govCMS8
5
star
8

govcms8-scaffold-paas

GovCMS8 PaaS Project Scaffolding
PHP
5
star
9

scaffold

PHP
5
star
10

govcms8-scaffold

Clone this repository to setup a GovCMS SaaS Drupal 8 Site for use on Lagoon
Gherkin
4
star
11

dvf

Data Visualisation Framework for Drupal 8
PHP
4
star
12

ui-kit-base-theme

DTA UI-kit (version 1.x) based Drupal (7.x) theme
CSS
4
star
13

govcmslagoon

GovCMS Lagoon project - Drupal 7
PHP
3
star
14

govCMS8-UI

[Experimental] Theme (based on DTA UI-kit version 2.x) for a govCMS Drupal 8 distribution
HTML
3
star
15

audit-site

govCMS site audit and remediation tool. Used to verify all sites built in, and for GovCMS SaaS meet the minimum requirements.
PHP
3
star
16

govstrap

a GovCMS light weight bootstrap base theme
PHP
2
star
17

eex

Theme for eex.gov.au
CSS
2
star
18

govcms7-scaffold

Clone this repository to setup a GovCMS SaaS Drupal 7 Site for use on Lagoon
Gherkin
2
star
19

DoESoE

Theme for Department of Environment (State of the Environment)
PHP
1
star
20

parkes

PHP
1
star
21

crimtrac_theme

CSS
1
star
22

govcms7-scaffold-paas

GovCMS Drupal 7 PaaS Project Scaffolding
PHP
1
star
23

FWBC

PHP
1
star
24

agdsa-theme

1
star
25

govcms-theme-ci

PHP
1
star
26

ona-theme

Theme for ona.gov.au on govCMS
CSS
1
star
27

govcms8_uikit

HTML
1
star
28

myhealthrecord-theme

CSS
1
star
29

govCMS-d8site

[Experimental] govCMS site based on the Drupal 8 Lightning distribution
HTML
1
star