Skip to content

Latest commit

 

History

History
160 lines (115 loc) · 8.88 KB

README.md

File metadata and controls

160 lines (115 loc) · 8.88 KB
Raw

wordpress-to-github development project

The development project for the wordpress-to-github NPM module NPM module. The readme for the development project is here.

Components

WordpressSync

An Azure Function as as Service (FaaS) site that operates on a Cron schedule to poll Wordpress sites for processing.

WordpressSyncHttpTrigger

An Azure Function as as Service (FaaS) site that can be the target for update notifications. Wordpress sites can be configured to hit this service when changes are made to trigger updates without waiting for the polling service.

The the trigger service is set to "authLevel": "function", so Azure FaaS Function Keys need to be maintained for trigger operations to work. See below for how to update them.

wordpress-to-github

The development package for the wordpress-to-github NPM module.

Config files

There are a few configuration files that need to be used.

endpoints.json

Contains the projects to process with the service.

{
  "$schema": "./endpoints.schema.json",
  "meta": {
    "title": "endpoints config file",
    "description": "endpoints config file"
  },
  "data": {
    "projects": [
      {
        "name": "drought.ca.gov",
        "description": "Drought production website",
        "enabled": true,
        "enabledLocal": false,
        "ReportingChannel_Slack": "C1234567890",
        "WordPressSource": {
          "url": "https://live-drought-ca-gov.pantheonsite.io",
          "tags_exclude": ["staging", "development"]
        },
        "GitHubTarget": {
          "Owner": "cagov",
          "Repo": "drought.ca.gov",
          "Branch": "main",
          "ConfigPath": "wordpress/wordpress-to-github.config.json"
        }
      }
    ]
  }
}
Name Description
name Friendly name for this job when it runs locally.
description Describe what this is being used for in this endpoint configuration.
enabled Should we process this endpoint?
enabledLocal Should we process this endpoint when running in local development?
ReportingChannel_Slack Slack channel to report activity to.
WordPressSource Describes the Wordpress instance to read from.
WordPressSource.url URL of the Wordpress instance to read from.
WordPressSource.tags_exclude Ignore Pages/Posts with these tags (Case sensitive!).
GitHubTarget The endpoint target to deploy changes.
GitHubTarget.Owner GitHub Owner.
GitHubTarget.Repo GitHub Repo.
GitHubTarget.Branch GitHub Target Branch.
GitHubTarget.ConfigPath Path to config.json file for this endpoint.

Setting up Local Execution/Debugging

When using Visual Studio Code, you can run the polling service locally. Only projects with enabledLocal: true will run. It is recommended that you keep all projects set to enabledLocal: false until you are sure you want to run them. The RUN AND DEBUG launch menu in VS Code should contain Debug DIRECT WordpressSync; use that to run locally with debugging.

local.settings.json

You will need to define a local.settings.json file in the project root with the following options.

{
  ...
  "Values": {
    ...
    "GITHUB_NAME": "...Your GitHub Name...",
    "GITHUB_EMAIL": "...Your GitHub Email...",
    "GITHUB_TOKEN": "...Your GitHub API Token...",
    "SLACKBOT_TOKEN":"...Your Slackbot API Token..."
    ...
  }
}
Name Description
GITHUB_NAME The name that will appear on commits.
GITHUB_EMAIL The email that will appear on commits.
GITHUB_TOKEN Your token used to authenticate with GitHub. Get one here.
SLACKBOT_TOKEN Your token used to authenticate with your Slack app. Make one here.

Local running with select projects

Running this project locally is a good way to see exactly what it is querying, what it decides to update and what commits it creates.

The config file WordpressSync/endpoints.json contains the list of all endpoints to be reviewed and which repos to push content updates to. The enabledLocal on every one of these is set to false by default.

If you run this project locally in VSCode while all the endpoints have "enabledLocal": false, it will stop execution after reviewing that file with a message that you need to enable at least one endpoint to make updates.

Execute this locally in VSCode by:

  • Selecting the debug section in the sidebar (triangle with bug icon)
  • Choosing Debug DIRECT WordpressSync from the RUN AND DEBUG pulldown menu at the top of the right sidebar
  • Clicking the triangle next to your pulldown selection to begin execution

Executing the code on a live endpoint will behave exactly as this does in production, it will check for updates at the server endpoint, create a commit of these changes to the target repository specified in endpoints.json and send slack notifications to the channel specified.

These commits will be performed with the account associated with your github token in your local.settings.json file. The local.settings.json file is gitignored and never committed to the repository. If it were accidentally committed github would immediately invalidate the exposed token and notify the committer. Individuals without access to accounts with permission to commit directly to the associated repo will not be able to create tokens the service can use to commit changes.

Slack messages can be redirected to your own debug channels by changing the channel id or disabled by removing the ReportingChannel_Slack value from the project which you have "enabledLocal": true.

When an endpoint is enabled it will be queried for each supported WordPress object type (Post/Page/Media), the VSCode command line console will show the running function's log output which will list the endpoints it is reviewing for updates.

If an update is discovered the service will create a commit and logs will print a link to the commit created on github.

If no update is discovered no further output is displayed.

This polling service is executing in its production FaaS instance on a 2 minute timer. Running it locally will be performing the same actions occuring constantly in production against the same endpoints and github repos defined in the endpoints.json file.

Local running just like the real instance

You can run all projects just like the real instance, by clearing the environment debug setting in WordpressSync\debug.js.

process.env.debug = true; //set to false or remove to run like the real instance

enabledLocal is ignored using this method. The enabled setting in each project is used, just like the real running instance.

Setting Trigger App Keys

App keys need to be kept secret. They are required to authenticate to the function service from a WordPress notification instance. The keys are added to the end of the URL (as &code=) that will POST to the WordpressSyncHttpTrigger function. WordpressSyncHttpTrigger runs in "authLevel": "function" mode that requires App Keys to operate.

To view the keys.

  1. As an Admin, go the the Function App in Azure.
  2. On the side bar, select App Keys.
  3. The list of Host keys (all functions) contains your active keys.

With the list of keys you can...

  • View an existing key by clicking Hidden value. Click to show value
  • Create a New host key for assigning to a new WordPress notification instance
  • Renew key value to invalidate an old key for replacement
  • 🗑️ Delete a key that should no longer be used

Make sure to name the key appropriately, and have a unique key per consuming site. Using the domain name as the key name is a good idea.