Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .adr-dir
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/architecture/decisions
5 changes: 0 additions & 5 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,3 @@ updates:
directory: "/"
schedule:
interval: daily
- package-ecosystem: composer
directory: "/"
schedule:
interval: daily
open-pull-requests-limit: 0
26 changes: 26 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Rust

on:
push:
pull_request:

env:
CARGO_TERM_COLOR: always

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build
run: |
rustup --version
./script/test
- name: Cache dependencies
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
40 changes: 0 additions & 40 deletions .github/workflows/main.yml

This file was deleted.

13 changes: 5 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
/vendor
/tests/plugins-test-dir
/docker-images/.DS_Store
/docker-images/whippet-wordpress/.DS_Store
npm-debug.log
/.php_cs.cache
/.php-cs-fixer.cache
/.phpunit.result.cache


# Added by cargo

/target
9 changes: 0 additions & 9 deletions .php-cs-fixer.php

This file was deleted.

3 changes: 1 addition & 2 deletions Brewfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
brew "php@7.4"
brew "composer"
brew "rust"
brew "shellcheck"
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

## Added
- Cargo tooling for Rust

### Changed
- Use current dxw Git URIs for documentation and tests

### Removed
- PHP version of Whippet

## [v2.5.0] - 2024-07-24

### Added
Expand Down
7 changes: 7 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[package]
name = "whippet"
version = "3.0.0"
edition = "2024"

[dependencies]
69 changes: 2 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,7 @@
# Whippet

This project is a framework for building WordPress applications that eases deployment, plugin management and build steps. Whippet is part of dxw's work to build and host WordPress-based applications that conform more closely to 12-factor principles.

Whippet has a few basic goals:

1. Allowing proper build steps to take place, that automate build tasks both during development and deployment
2. Properly managing plugins and themes, allowing them to be version controlled and easily updated
3. Managing the creation of releases, including rollbacks
4. Automating the generation of commonly required objects like new applications and new themes

Whippet can manage plugins and themes and releases.

During development, whippet can be used in conjunction with [wpc](https://github.com/dxw/wpc).

*Whippet is under development and should be considered alpha software. If you use it, we'd love to know what you think.*

## Getting started

You will need:

* [PHP](https://www.php.net/)
* [Composer](https://getcomposer.org/)
* [git](https://git-scm.com/)

### Install whippet

#### Via homebrew (recommended)

You can install Whippet via Homebrew by running:

```
brew install dxw/tap/whippet
```

#### From source

Whippet implements the [scripts to rule them all](https://github.com/github/scripts-to-rule-them-all)
pattern. To install Whippet from source, clone this repository:

```shell
$ git clone https://github.com/dxw/whippet.git
```

Then run the relevant script to setup your environment and install dependencies:

```shell
./script/setup
```

You might also want to symlink whippet to somewhere in your path:

```shell
sudo ln -s $PWD/bin/whippet /usr/local/bin/whippet
```

## Using Whippet

The main things you can use Whippet to do are:

* [Generating a Whippet application or theme](docs/generate.md)
* [Managing themes and plugins](docs/themesandplugins.md)
* [Deploying a Whippet application](docs/deploy.md)

## Support

For dxw developers who will encounter Whippet in a support context.

See the [Support](docs/support.md) doc.
This is an experimental re-write of Whippet. If you are trying to do something
useful please use the `main` branch.

## Licence

Expand Down
26 changes: 0 additions & 26 deletions bin/whippet

This file was deleted.

35 changes: 0 additions & 35 deletions composer.json

This file was deleted.

Loading