Skip to content

Beta testing instructions/alternative Composer config. #1

@jamesmacwhite

Description

@jamesmacwhite

Appreciate the plugin is currently in Beta and testers have been contacted, a potentially easier way to test the plugin without using a plugins directory is add a repository source so you can use composer require without having the plugin directly checked in to the plugins folder, as with modern Craft CMS, and composer, you don't really commit plugin files to the source anymore, although I know you can for private plugins or testing.

For Beta testers:

Important

Make a database backup as this plugin will modify existing database tables.

Add a repository entry to your composer.json

repositories: [
  {
    "url": "https://github.com/hybridinteractive/simple-contact-form",
    "type": "git"
  }
]

Add the following require line:

"hybridinteractive/simple-contact-form": "dev-main"

Then use composer require hybridinteractive/simple-contact-form as normal, which will pull the latest commit from the main branch of this repository. You can also lock the composer package to a specific commit e.g. dev-main#commit-hash

When an official release is made, it will be available by Packagist and the repository entry can be removed, the composer package version can be amended to official first release e.g. ^1.0 or similar.

Then install the plugin with:

craft plugin/install simple-contact-form

The migration to rename the original database submissions table from the older CFE plugin should be executed automatically:

 *** installing simple-contact-form
    > rename table {{%contactform_submissions}} to {{%simplecontactform_submissions}} ... done (time: 0.028s)                                                                                                                    
*** installed simple-contact-form successfully (time: 0.058s)

Uninstall any contact-form plugins, e.g. the Craft CMS contact form plugin and any CFE extensions.

Migrate existing CFE contact form code and logic to new plugin. Test and report bugs!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions