Skip to content

Commit 8faca97

Browse files
committed
refactor: remove magnolia module
1 parent 4fe9ea1 commit 8faca97

29 files changed

+3
-1423
lines changed

.github/workflows/publish-mvn-package.yaml

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 3 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,8 @@ In case we don't want to operate the delivery tier ourselves and instead use a C
2626
For the content management tier we provide two submodules which together with a queue handle the propagation of content change events:
2727

2828
1. [Paperboy push service](./paperboy-push-service): A small HTTP service that can be used as a webhook.
29-
2. [Paperboy Magnolia module](./paperboy-magolia-module): A module that integrates directly into Magnolia and sends HTTP messages to the push service (or an arbitrary webhook) whenever a change in a watched workspace occurs.
3029

31-
The subscriber part of this system is currently comprised of three submodules in this repository:
30+
The subscriber part of this system is currently comprised of two submodules in this repository:
3231

3332
1. [Paperboy Core](./paperboy-core): The core library which handles all generic configuration and knows how to execute the commands to trigger rebuilds.
3433
2. [Paperboy CLI](./paperboy-cli): A simple CLI to ease usage and setup
@@ -51,11 +50,7 @@ $ curl -X POST \
5150
-d 'payload=%7B%22foo%22%3A%22bar%22%7D&source=foo'
5251
```
5352

54-
## Installation
55-
56-
To get started with your project, execute the stepts in [Frontend Set-Up](#frontend-set-up) and [Magnolia Set-Up](#magnolia-set-up). Afterwards either execute the steps from [Custom delivery layer](#custom-delivery-layer) or [Netlify](#netlify) depending on your setup.
57-
58-
### Frontend Set-Up
53+
### Set-Up
5954

6055
To use Paperboy in your Frontend you can simply install the CLI globally via:
6156

@@ -69,44 +64,12 @@ In case that you are writing the frontend with JavaScript you can also install t
6964
$ npm i --save-dev @neoskop/paperboy-cli
7065
```
7166

72-
### Magnolia Set-Up
73-
74-
Generate a blank Magnolia project using Magnolia's archetype catalog:
75-
76-
```bash
77-
$ mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeCatalog=https://nexus.magnolia-cms.com/content/groups/public/ \
78-
-Dfilter=info.magnolia.maven.archetypes:magnolia-project-archetype
79-
```
80-
81-
Afterwards add the Paperboy Magnolia Module to the webapp's POM.xml:
82-
83-
```xml
84-
<dependency>
85-
<groupId>de.neoskop.magnolia</groupId>
86-
<artifactId>paperboy</artifactId>
87-
<version>2.0.0</version>
88-
</dependency>
89-
```
90-
91-
Build the WAR and deploy it in a servlet container.
92-
93-
### Custom delivery layer
94-
95-
In case of a custom deliver layer, start the push service and a NATS server by running the following command in the root folder of this repository:
67+
Start the push service and a NATS server by running the following command in the root folder of this repository:
9668

9769
```bash
9870
$ docker-compose up
9971
```
10072

101-
When the containers are up and running, import the following config into Magnolia's configuration under `/modules/paperboy/config`:
102-
103-
```yaml
104-
webhookConfig:
105-
authorization: BEARER_TOKEN
106-
bearerToken: supersecret
107-
url: http://push-service:8080/
108-
```
109-
11073
To configure the frontend, create a file called `paperboy.config.json` with the following contents:
11174

11275
```json
@@ -124,30 +87,6 @@ Finally change to the frontend directory and run:
12487
$ paperboy start
12588
```
12689

127-
### Netlify
128-
129-
To trigger a rebuild of the frontend whenever a change in Magnolia's content occurs, create a webhook in Netlify under `Settings > Build & Deploy` in your project.
130-
131-
Click "Add build hook":
132-
133-
![Webhook Creation pt. 1](images/netlify-webhook-01.png)
134-
135-
Give the hook a meaningful name and press "Save":
136-
137-
![Webhook Creation pt. 2](images/netlify-webhook-02.png)
138-
139-
Copy the webhook's URL:
140-
141-
![Webhook Creation pt. 2](images/netlify-webhook-03.png)
142-
143-
Finally import the following config into Magnolia's configuration under `/modules/paperboy/config`:
144-
145-
```yaml
146-
webhookConfig:
147-
authorization: NONE
148-
url: https://api.netlify.com/build_hooks/<webhook-id>
149-
```
150-
15190
## License
15291

15392
This project is under the terms of the Apache License, Version 2.0. A [copy of this license](LICENSE) is included with the sources.

paperboy-magnolia-module/.gitignore

Lines changed: 0 additions & 8 deletions
This file was deleted.

paperboy-magnolia-module/pom.xml

Lines changed: 0 additions & 183 deletions
This file was deleted.

paperboy-magnolia-module/src/main/java/de/neoskop/magnolia/PaperboyModule.java

Lines changed: 0 additions & 55 deletions
This file was deleted.

paperboy-magnolia-module/src/main/java/de/neoskop/magnolia/WebhookAuthorization.java

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)