Skip to content

Commit

Permalink
Merge branch 'develop' into trunk
Browse files Browse the repository at this point in the history
  • Loading branch information
dkotter committed Feb 3, 2025
2 parents e774cb6 + f224ef0 commit 35e7ad4
Show file tree
Hide file tree
Showing 14 changed files with 679 additions and 1,475 deletions.
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
name: No Response
name: 'Close stale issues'

# **What it does**: Closes issues where the original author doesn't respond to a request for information.
# **Why we have it**: To remove the need for maintainers to remember to check back on issues periodically to see if contributors have responded.
# **Who does it impact**: Everyone that works on docs or docs-internal.

on:
issue_comment:
types: [created]
schedule:
# Schedule for five minutes after the hour, every hour
- cron: '5 * * * *'
# Schedule for every day at 1:30am UTC
- cron: '30 1 * * *'

permissions:
issues: write

jobs:
noResponse:
stale:
runs-on: ubuntu-latest
steps:
- uses: lee-dohm/[email protected]
- uses: actions/stale@v9
with:
token: ${{ github.token }}
daysUntilClose: 14 # Number of days of inactivity before an Issue is closed for lack of response
responseRequiredLabel: "needs:feedback" # Label indicating that a response from the original author is required
closeComment: >
days-before-stale: 7
days-before-close: 7
stale-issue-message: >
It has been 7 days since more information was requested from you in this issue and we have not heard back. This issue is now marked as stale and will be closed in 7 days, but if you have more information to add then please comment and the issue will stay open.
close-issue-message: >
This issue has been automatically closed because there has been no response
to our request for more information. With only the
information that is currently in the issue, we don't have enough information
to take action. Please reach out if you have or find the answers we need so
that we can investigate further. See [this blog post on bug reports and the
importance of repro steps](https://www.lee-dohm.com/2015/01/04/writing-good-bug-reports/)
for more information about the kind of information that may be helpful.
stale-issue-label: 'stale'
close-issue-reason: 'not_planned'
any-of-labels: 'needs:feedback'
remove-stale-when-updated: true

6 changes: 3 additions & 3 deletions .github/workflows/cypress.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ jobs:
- {name: 'PHP 7.4', version: '7.4'}
core:
- {name: 'WP stable', version: 'latest'}
- {name: 'WP 5.7', version: 'WordPress/WordPress#5.7'}
- {name: 'WP minimum', version: 'WordPress/WordPress#6.5'}
- {name: 'WP trunk', version: 'WordPress/WordPress#master'}
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Download build zip
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: ${{ github.event.repository.name }}
path: ${{ github.event.repository.name }}
Expand Down Expand Up @@ -65,7 +65,7 @@ jobs:
npx mochawesome-report-generator tests/cypress/reports/mochawesome.json -o tests/cypress/reports/
cat ./tests/cypress/reports/mochawesome.md >> $GITHUB_STEP_SUMMARY
- name: Make artifacts available
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
if: failure()
with:
name: cypress-artifact
Expand Down
31 changes: 31 additions & 0 deletions .github/workflows/repo-automator.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: 'Repo Automator'
on:
issues:
types:
- opened
push:
branches:
- develop
pull_request:
types:
- opened
- edited
- synchronize
- converted_to_draft
- ready_for_review
branches:
- develop

jobs:
Validate:
runs-on: ubuntu-latest
steps:
- uses: 10up/action-repo-automator@trunk
with:
fail-label: needs:feedback
pass-label: needs:code-review
conflict-label: needs:refresh
reviewers: |
team:open-source-practice
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21 changes: 21 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,26 @@ All notable changes to this project will be documented in this file, per [the Ke

## [Unreleased]

## [1.2.5] - 2025-02-03
**Note that this release bumps the WordPress minimum version from 5.7 to 6.5.**

### Added
- Documentation updates comparing Classic Editor vs. Gutenberg (Block Editor) XML exports for InDesign imports (props [@frankiebordone](https://github.com/frankiebordone), [@dkotter](https://github.com/dkotter) via [#159](https://github.com/10up/eight-day-week/pull/159), [#160](https://github.com/10up/eight-day-week/pull/160)).

### Changed
- Bump WordPress "tested up to" version to 6.7 (props [@qasumitbagthariya](https://github.com/qasumitbagthariya), [@sudip-md](https://github.com/sudip-md), [@zamanq](https://github.com/zamanq), [@jeffpaul](https://github.com/jeffpaul) via [#144](https://github.com/10up/eight-day-week/pull/144), [#152](https://github.com/10up/eight-day-week/pull/152), [#153](https://github.com/10up/eight-day-week/pull/153), [#163](https://github.com/10up/eight-day-week/pull/163), [#165](https://github.com/10up/eight-day-week/pull/165)).
- Bump WordPress minimum from 5.7 to 6.5 (props [@qasumitbagthariya](https://github.com/qasumitbagthariya), [@sudip-md](https://github.com/sudip-md), [@zamanq](https://github.com/zamanq), [@jeffpaul](https://github.com/jeffpaul) via [#144](https://github.com/10up/eight-day-week/pull/144), [#152](https://github.com/10up/eight-day-week/pull/152), [#153](https://github.com/10up/eight-day-week/pull/153)).

### Security
- Bump `braces` from 3.0.2 to 3.0.3 and `ws` from 6.2.2 to 6.2.3 (props [@dependabot](https://github.com/apps/dependabot), [@iamdharmesh](https://github.com/iamdharmesh) via [#150](https://github.com/10up/eight-day-week/pull/150)).

### Developer
- Upgrade `download-artifact` from v3 to v4 (props [@iamdharmesh](https://github.com/iamdharmesh), [@jeffpaul](https://github.com/jeffpaul) via [#142](https://github.com/10up/eight-day-week/pull/142)).
- Replaced `lee-dohm/no-response` with `actions/stale` to help with closing no-response/stale issues (props [@jeffpaul](https://github.com/jeffpaul), [@dkotter](https://github.com/dkotter) via [#143](https://github.com/10up/eight-day-week/pull/143)).
- Add "Testing" section to the "CONTRIBUTING.md" file (props [@kmgalanakis](https://github.com/kmgalanakis) via [#145](https://github.com/10up/eight-day-week/pull/145)).
- Add Repo Automator GitHub Action (props [@iamdharmesh](https://github.com/iamdharmesh), [@jeffpaul](https://github.com/jeffpaul) via [#146](https://github.com/10up/eight-day-week/pull/146)).
- Update README with WordPress Playground badge, banner image and other minor updates (props [@jeffpaul](https://github.com/jeffpaul), [@dkotter](https://github.com/dkotter) via [#156](https://github.com/10up/eight-day-week/pull/156), [#157](https://github.com/10up/eight-day-week/pull/157), [#158](https://github.com/10up/eight-day-week/pull/158)).

## [1.2.4] - 2024-02-29
### Added
- Support for the WordPress.org plugin preview (props [@dkotter](https://github.com/dkotter), [@jeffpaul](https://github.com/jeffpaul) via [#137](https://github.com/10up/eight-day-week/pull/137)).
Expand Down Expand Up @@ -129,6 +149,7 @@ All notable changes to this project will be documented in this file, per [the Ke
- Initial Release

[Unreleased]: https://github.com/10up/eight-day-week/compare/trunk...develop
[1.2.5]: https://github.com/10up/eight-day-week/compare/1.2.4...1.2.5
[1.2.4]: https://github.com/10up/eight-day-week/compare/1.2.3...1.2.4
[1.2.3]: https://github.com/10up/eight-day-week/compare/1.2.2...1.2.3
[1.2.2]: https://github.com/10up/eight-day-week/compare/1.2.1...1.2.2
Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ Pull requests represent a proposed solution to a specified problem. They should

For more on how 10up writes and manages code, check out our [10up Engineering Best Practices](https://10up.github.io/Engineering-Best-Practices/).

### Testing

Helping to test an open source project and provide feedback on success or failure of those tests is also a helpful contribution. You can find details on the Critical Flows and Test Cases in [this project's GitHub Wiki](https://github.com/10up/eight-day-week/wiki) as well as details on our overall approach to [Critical Flows and Test Cases in our Open Source Best Practices](https://10up.github.io/Open-Source-Best-Practices/testing/#critial-flows). Submitting the results of testing via our Critical Flows as a comment on a Pull Request of a specific feature or as an Issue when testing the entire project is the best approach for providing testing results.

## Workflow

The `develop` branch is the development branch which means it contains the next version to be released. `stable` contains the current latest release and `trunk` contains the corresponding stable development version. Always work on the `develop` branch and open up PRs against `develop`.
Expand Down
2 changes: 1 addition & 1 deletion CREDITS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The following individuals are responsible for curating the list of issues, respo

Thank you to all the people and companies who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc.

[10up (@10up)](https://github.com/10up), [Observer Media (@observermedia)](https://github.com/observermedia), [Josh Levinson (@joshlevinson)](https://github.com/joshlevinson), [Brent Schultz (@brs14ku)](https://github.com/brs14ku), [Jeff Sternberg (@sternb0t)](https://github.com/sternb0t), [Anthony Castro (@anthony-j-castro)](https://github.com/anthony-j-castro), [Josh Pollock (@Shelob9)](https://github.com/Shelob9), [Adam Silverstein (@adamsilverstein)](https://github.com/adamsilverstein), [Matthias Wehrlein (@maryisdead)](https://github.com/maryisdead), [Chris Wallace (@chriswallace)](https://github.com/chriswallace), [Jared Williams (@Jared-Williams)](https://github.com/Jared-Williams), [Helen Hou-Sandí (@helen)](https://github.com/helen), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Ryan Welcher (@ryanwelcher)](https://github.com/ryanwelcher), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Mohit Dadhich (@mohitwp)](https://github.com/mohitwp), [Max Lyuchin (@cadic)](https://github.com/cadic), [Tung Du (@dinhtungdu)](https://github.com/dinhtungdu), [Vikram Moparthy (@vikrampm1)](https://github.com/vikrampm1), [Dhanendran Rajagopal (@dhanendran)](https://github.com/dhanendran), [Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Quamruz Zaman (@zamanq)](https://github.com/zamanq), [Jayedul Kabir (@jayedul)](https://github.com/jayedul), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Ben Marshall (@bmarshall511)](https://github.com/bmarshall511), [Shazahan Kabir Saju (@sksaju)](https://github.com/sksaju), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9), [Faisal Alvi (@faisal-alvi)](https://github.com/faisal-alvi), [Ravinder Kumar (@ravinderk)](https://github.com/ravinderk), [Dependabot (@dependabot)](https://github.com/dependabot), [xLesy (@xLesy)](https://github.com/xLesy).
[10up (@10up)](https://github.com/10up), [Observer Media (@observermedia)](https://github.com/observermedia), [Josh Levinson (@joshlevinson)](https://github.com/joshlevinson), [Brent Schultz (@brs14ku)](https://github.com/brs14ku), [Jeff Sternberg (@sternb0t)](https://github.com/sternb0t), [Anthony Castro (@anthony-j-castro)](https://github.com/anthony-j-castro), [Josh Pollock (@Shelob9)](https://github.com/Shelob9), [Adam Silverstein (@adamsilverstein)](https://github.com/adamsilverstein), [Matthias Wehrlein (@maryisdead)](https://github.com/maryisdead), [Chris Wallace (@chriswallace)](https://github.com/chriswallace), [Jared Williams (@Jared-Williams)](https://github.com/Jared-Williams), [Helen Hou-Sandí (@helen)](https://github.com/helen), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Ryan Welcher (@ryanwelcher)](https://github.com/ryanwelcher), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Mohit Dadhich (@mohitwp)](https://github.com/mohitwp), [Max Lyuchin (@cadic)](https://github.com/cadic), [Tung Du (@dinhtungdu)](https://github.com/dinhtungdu), [Vikram Moparthy (@vikrampm1)](https://github.com/vikrampm1), [Dhanendran Rajagopal (@dhanendran)](https://github.com/dhanendran), [Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Quamruz Zaman (@zamanq)](https://github.com/zamanq), [Jayedul Kabir (@jayedul)](https://github.com/jayedul), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Ben Marshall (@bmarshall511)](https://github.com/bmarshall511), [Shazahan Kabir Saju (@sksaju)](https://github.com/sksaju), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9), [Faisal Alvi (@faisal-alvi)](https://github.com/faisal-alvi), [Ravinder Kumar (@ravinderk)](https://github.com/ravinderk), [Dependabot (@dependabot)](https://github.com/dependabot), [xLesy (@xLesy)](https://github.com/xLesy), [Frankie Bordone (@frankiebordone)](https://github.com/frankiebordone), [Sumit Bagthariya (@qasumitbagthariya)](https://github.com/qasumitbagthariya), [Sudip Dadhaniya (@sudip-md)](https://github.com/sudip-md), [Konstantinos Galanakis (@kmgalanakis)](https://github.com/kmgalanakis).

## Libraries

Expand Down
42 changes: 27 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
# ![Eight Day Week Print Workflow](https://github.com/10up/eight-day-week/blob/develop/.wordpress-org/banner-1544x500.png "Eight Day Week Print Workflow")
# Eight Day Week Print Workflow

> Optimize publication workflows by using WordPress as your print CMS.
![Eight Day Week](https://github.com/10up/eight-day-week/blob/develop/.wordpress-org/banner-1544x500.png "Eight Day Week Print Workflow")

[![Support Level](https://img.shields.io/badge/support-stable-blue.svg)](#support-level) [![E2E tests](https://github.com/10up/eight-day-week/actions/workflows/cypress.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/cypress.yml) [![Release Version](https://img.shields.io/github/release/10up/eight-day-week.svg)](https://github.com/10up/eight-day-week/releases/latest) ![WordPress tested up to version](https://img.shields.io/wordpress/plugin/tested/eight-day-week-print-workflow?label=WordPress) [![GPLv2 License](https://img.shields.io/github/license/10up/eight-day-week.svg)](https://github.com/10up/eight-day-week/blob/develop/LICENSE.md)
[![Support Level](https://img.shields.io/badge/support-stable-blue.svg)](#support-level) ![Required PHP Version](https://img.shields.io/wordpress/plugin/required-php/eight-day-week-print-workflow?label=Requires%20PHP) ![Required WP Version](https://img.shields.io/wordpress/plugin/wp-version/eight-day-week-print-workflow?label=Requires%20WordPress) ![WordPress tested up to version](https://img.shields.io/wordpress/plugin/tested/eight-day-week-print-workflow?label=WordPress) [![GPLv2 License](https://img.shields.io/github/license/10up/eight-day-week.svg)](https://github.com/10up/eight-day-week/blob/develop/LICENSE.md) [![Dependency Review](https://github.com/10up/eight-day-week/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/dependency-review.yml) [![E2E tests](https://github.com/10up/eight-day-week/actions/workflows/cypress.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/cypress.yml) [![PHP Standards Scrutinizer](https://github.com/10up/eight-day-week/actions/workflows/php-standards-scrutinizer.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/php-standards-scrutinizer.yml) [![CodeQL](https://github.com/10up/eight-day-week/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/github-code-scanning/codeql) [![WordPress Playground Demo](https://img.shields.io/wordpress/plugin/v/eight-day-week-print-workflow?logo=wordpress&logoColor=FFFFFF&label=Playground%20Demo&labelColor=3858E9&color=3858E9)](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/10up/eight-day-week/develop/.wordpress-org/blueprints/blueprint.json)

## Table of Contents
* [Overview](#overview)
* [Features](#features)
* [Requirements](#requirements)
* [Installation](#installation)
* [Filters & Hooks](#filters--hooks)
* [Screenshots](#screenshots)
* [Known Caveats/Issues](#known-caveatsissues)
* [Changelog](#changelog)
* [Contributing](#contributing)
> Optimize publication workflows by using WordPress as your print CMS.
## Overview

Expand Down Expand Up @@ -45,7 +36,25 @@ Two custom roles are added by this plugin to best model a real-world print team.

![A Print Issue in "read only view". This view allows anyone with access to view a Print Issue without inducing a post lock, or being locked out by another editor. Note that the Export tools are still available in read only view.](/.wordpress-org/screenshot-3.png)

### XML Export to InDesign
### XML Export to InDesign: **Classic Editor vs. Gutenberg Exports**

When exporting content from WordPress for use in InDesign, there are key differences between **Classic Editor** and **Gutenberg (Block Editor)** exports. This section highlights how each type of export behaves in InDesign and offers guidance on how to handle these differences. You can test how this works in your version of InDesign with these sample XML files: [Gutenberg XML](https://raw.githubusercontent.com/wiki/10up/eight-day-week/BlockEditor-sample.xml), [Classic Editor XML](https://raw.githubusercontent.com/wiki/10up/eight-day-week/ClassicEditor-sample.xml)

#### **Classic Editor Exports**
- The XML structure generated by the Classic Editor is simple and straightforward, using basic HTML tags like `<p>`, `<strong>`, and `<em>` for paragraphs, bold, and italic text.
- No extra metadata or block-related comments are present, which allows for a smoother import into InDesign without any unnecessary elements.

#### **Gutenberg Exports**
- Gutenberg-based exports include additional metadata in the form of HTML comments (e.g., `<!-- wp:paragraph -->`) that wrap around content blocks. These comments contain details about block configurations and alignments.
- While the extra block metadata does not invalidate the XML, InDesign may not process these comments correctly, requiring manual adjustments to clean up or remove them.

#### **InDesign Import Differences**
- **Classic Editor**: Imports smoothly into InDesign without any issues, as the structure is simple, and no unnecessary metadata is present.
- **Gutenberg**: The extra block comments and metadata may not be recognized by InDesign and could interfere with the import. Users may need to manually clean up these comments or adjust formatting after the import to achieve the desired layout.

#### **Recommendations**
- **Classic Editor**: Ideal for seamless imports with minimal manual adjustments.
- **Gutenberg**: Recommended for users familiar with InDesign who are comfortable with making adjustments to remove unnecessary metadata or fine-tune block-specific settings after import.

- Export XML files specifically formatted for import into InDesign

Expand All @@ -58,13 +67,14 @@ Issue Statuses | Publications | Article Statuses
## Requirements

* PHP 7.4+
* [WordPress](http://wordpress.org) 5.7+
* [WordPress](http://wordpress.org) 6.4+

## Installation

Eight Day Week has no settings or configurations to set up. It just works!

## Filters & Hooks

Eight Day Week provides a number of filters and hooks for customizing and extending the plugin.

### Modules
Expand All @@ -87,13 +97,15 @@ The information displayed in the list of articles within a Print Issue is filter

Sample usage:

```
add_filter( 'Eight_Day_Week\Articles\article_columns', function( $columns ) {
$columns['byline'] = _x( 'Byline', 'Label for multiple, comma separated authors', 'your-text-domain' );
return $columns;
} );
add_filter( 'Eight_Day_Week\Articles\article_meta_byline', function( $incoming_value, $post ) {
return implode( ', ', wp_list_pluck( my_get_post_authors_function( $post ), 'display_name' ) );
}
```

### Print Issue Table

Expand Down
Loading

0 comments on commit 35e7ad4

Please sign in to comment.