pressbooks / composer-autoupdate-bedrock

Auto updater action 🤖

Pressbooks

Contributors: Pressbooks [email protected] Tags: ebooks, publishing, webbooks Requires at least: 6.5.0 Tested up to: 6.5.0 Stable tag: 6.18.1 Requires PHP: 8.1 License: GPL v3.0 or later License URI: https://github.com/pressbooks/pressbooks/blob/production/LICENSE.md

Pressbooks is an open source book publishing tool built on a WordPress multisite platform.

Description

Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS. Pressbooks is free software, released under the GPL v3.0 or later license.

Our webbooks and EPUB/PDF exports are all driven by HTML + CSS. XML outputs have no styling.

Requirements

Pressbooks works with PHP 8.1 and WordPress 6.5.0. Lower versions are not supported.

Installing the Plugin

Pressbooks is not for use on an existing blog. Instead it should be used with a fresh, multisite WordPress installation.

To install Pressbooks on your site, download the latest release and follow our installation instructions.

You may want to try Pressbooks.com before deciding whether or not you wish to host and maintain your own instance of Pressbooks. We can also host and maintain an instance of Pressbooks for you.

Contributor guidelines

Developers who are interested in contributing to our project should consult our "Contributing" guidelines and the developer guides published on our documentation website.

Disclaimers

The Pressbooks plugin is supplied "as is" and all use is at your own risk.

Changelog

6.18.1

• See: https://github.com/pressbooks/pressbooks/releases/tag/6.18.1
• Full release history available at: https://github.com/pressbooks/pressbooks/releases

Upgrade Notices

6.18.0

• Pressbooks 6.18.0 requires WordPress 6.5.0

6.17.0

• Pressbooks 6.17.0 requires WordPress 6.4.3

6.15.2

• Pressbooks 6.15.2 requires WordPress 6.4.2

6.15.1

• Pressbooks 6.15.1 requires WordPress 6.3.1

6.12.0

• Pressbooks 6.12.0 requires WordPress 6.2.2

6.10.0

• Pressbooks 6.10.0 requires WordPress 6.2

6.9.0

• Pressbooks 6.9.0 requires PHP >= 8.1

6.4.0

• Pressbooks 6.4.0 requires PHP >= 8.0
• Pressbooks 6.4.0 requires WordPress 6.1.1

6.0.0

• Pressbooks 6.0.0 requires WordPress 6.0.2

5.34.1

• Pressbooks 5.34.1 requires WordPress 5.9.3
• Pressbooks 5.34.1 requires McLuhan >= 2.18.1

5.34.0

• Pressbooks 5.34.0 requires McLuhan >= 2.18.0
• Pressbooks 5.34.0 requires PHP >= 7.4

5.33.0

• Pressbooks 5.33.0 requires McLuhan >= 2.17.0

5.32.0

• Pressbooks 5.32.0 requires WordPress 5.9
• Pressbooks 5.32.0 requires McLuhan >= 2.16.0

5.31.0

• Pressbooks 5.31.0 requires McLuhan >= 2.15.0

5.30.0

• Pressbooks 5.30.0 requires WordPress 5.8.2
• Pressbooks 5.30.0 requires McLuhan >= 2.14.0

5.27.0

• Pressbooks 5.27.0 requires WordPress 5.8.1
• Pressbooks 5.27.0 requires McLuhan >= 2.13.0

5.25.0

• Pressbooks 5.25.0 requires WordPress 5.8

5.21.0

• Pressbooks 5.21.0 requires WordPress 5.7.2

5.20.1

• Pressbooks 5.20.1 requires WordPress 5.6.2

5.18.0

• Pressbooks 5.18.0 requires PHP >= 7.3
• Pressbooks 5.18.0 requires WordPress 5.5.3

5.16.0

• If you are using the plugin (Lord of the Files)[https://wordpress.org/plugins/blob-mimes/] version <=1.0.0, this upgrade will break your application. To fix this, you would need to update Lord of the files plugin to at least 1.1.0.

5.15.1

• Pressbooks 5.15.1 requires PHP >= 7.1.
• Pressbooks 5.15.1 requires WordPress 5.4
• Pressbooks 5.15.1 requires McLuhan >= 2.10.2

composer-autoupdate-bedrock's Issues

Improve automerge check

Gracefully skip the check if the PR title doesn't match the constraints to be auto merged

Improve behaviour when merging a bunch or PRs

Sometimes we got octokit errors due API rate limits and also the PRs got stacked causing race conditions that lead to composer.lock file conflicts

Split lint theme workflow in a new action that would be reused by all our themes

• Move the action to a better location
• Make sure it's used in pressbooks-book and all themes
• Write minimal docs for using/updating

See https://github.blog/2023-01-10-introducing-required-workflows-and-configuration-variables-to-github-actions/ for promising approach for this from GitHub

Repo with the first iteration of docs and reusable/required actions:

https://github.com/pressbooks/reusable-workflows

Update auto-merge workflow

Our current auto-merge script is using the old version of github scripts that uses node 12

--
Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: actions/[email protected]. 
For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.Show more

I started the refactor here:

#58

But is still showing some errors, so in order to tag and release we should address this first:

https://github.com/pressbooks/uses-updater/actions/runs/3999909306/jobs/6864792893#step:2:26

Automatically update pressbookscom bedrock

Our composer autoupdate routine hasn't been configured for our pressbookscom-bedrock (used by our marketing website):

composer-autoupdate-bedrock/index.js

Lines 4 to 8 in b9aea1e

	const reposToDispatchComposerUpdate = [
	'pressbooksedu-golden-bedrock',
	'pressbookspublic-bedrock',
	'pressbookspub-bedrock'
	];

It should.

Fix autoupdate and automerge to work with new branch/PR linting rules

The commits and PRs automatically created by our composer-autoupdate action no longer pass our globally required branch and PR linting rules. See https://github.com/pressbooks/pressbookspublic-bedrock/pull/569 for a failing PR.

We should update our composer-autoupdate-bedrock action so that the PR branch name and commits match our new rules (i.e. the branch is called something like chore/dev-updated and the commit and PR titles look like chore: composer update with 4 changes. See the GIT_COMMIT_PREFIX command available here: https://github.com/kawax/composer-update-action#env. i don't know how to make the branch name match the regex -- i only see a suffix command in the parent action.

We'll also need to adjust

composer-autoupdate-bedrock/.github/workflows/auto-merge.yml

Line 7 in 028a758

if: startsWith(github.event.pull_request.title, 'Composer update with')

Improve composer autoupdate behaviour

Our current plugins and themes have a GitHub action step setup after running tests and all the build process that looks like the following:

  - name: Trigger Bedrock Update
      if: (github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/production')  && matrix.experimental == false
      uses: pressbooks/composer-autoupdate-bedrock@v2
      with:
        triggered-by: ${{ github.repository }}
        token: ${{ secrets.PAT_COMPOSER_UPDATE }}
        branch: ${{ github.ref }}

Our current implementation has a couple of things that should be improved.

1. Plugins/Themes that trigger a bedrock update needs to only trigger the bedrocks that contains a reference of the plugin that is triggering the update, right now It's triggering a GENERAL update in all registered bedrocks

The following list of bedrocks is hardcoded in the composer-autoupdate-action repo

const reposToDispatchComposerUpdate = [
    'pressbooksedu-golden-bedrock',
    'pressbookspublic-bedrock',
    'pressbookspub-bedrock'
];

See #72 for a related issue.

There are different ways to solve that for example

1. Send the bedrocks to update as a parameter in each plugin/theme (also this could be a reusable step that can be shared by different associated repos)

  - name: Trigger Bedrock Update
      if: (github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/production')  && matrix.experimental == false
      uses: pressbooks/composer-autoupdate-bedrock@v2
      with:
        triggered-by: ${{ github.repository }}
        token: ${{ secrets.PAT_COMPOSER_UPDATE }}
        branch: ${{ github.ref }}
        bedrocks: ['golden','public','etc']

2. Fetch all the bedrocks composer.json files while updating and doing a quick lookup to see if the triggering repo contains the triggering plugin/theme and update if true

Pressbooks composer update failing on our bedrocks

Our composer update pipelines started to fail on all our bedrocks

When the update action tries to find the current branch name it fails and throws an exception. Could this be related to the APP_SINGLE_BRANCH parameter?

Fix problem with auto-update routine

I've noticed a problem with our autoupdate process:

1. In pressbooks/pressbooks, we have a post-commit action for dependabot PRs that autobuilds assets and commits them to the PR: https://github.com/pressbooks/pressbooks/blob/dev/.github/workflows/autobuild-dependabot-assets.yml. The problem here is that the PR cannot be merged because it skips the required 'lint & build assets' steps after this commit has been made. See pressbooks/pressbooks#3206 or screenshot below