Skip to content

Commit

Permalink
Merge branch 'develop' for 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
helen committed Jul 30, 2019
2 parents de7c4b0 + 30a577a commit f3dc82a
Show file tree
Hide file tree
Showing 30 changed files with 4,088 additions and 78 deletions.
16 changes: 16 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/.github export-ignore
/.wordpress-org export-ignore

/.bowerrc export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.jshintrc export-ignore
/CHANGELOG.md export-ignore
/CODE_OF_CONDUCT.md export-ignore
/composer.json export-ignore
/CONTRIBUTING.md export-ignore
/CONTRIBUTORS.md export-ignore
/Gruntfile.js export-ignore
/LICENSE.md export-ignore
/package-lock.json export-ignore
/README.md export-ignore
38 changes: 38 additions & 0 deletions .github/main.workflow
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
workflow "Deploy" {
resolves = ["WordPress Plugin Deploy"]
on = "push"
}

# Filter for tag
action "tag" {
uses = "actions/bin/filter@master"
args = "tag"
}

action "WordPress Plugin Deploy" {
needs = ["tag"]
uses = "10up/actions-wordpress/dotorg-plugin-deploy@master"
secrets = ["SVN_PASSWORD", "SVN_USERNAME", "GITHUB_TOKEN"]
env = {
SLUG = "eight-day-week-print-workflow"
}
}

workflow "Asset/readme update" {
resolves = ["Plugin Asset Update"]
on = "push"
}

action "Filters for GitHub Actions" {
uses = "actions/bin/filter@master"
args = "branch master"
}

action "Plugin Asset Update" {
uses = "10up/actions-wordpress/dotorg-plugin-asset-update@master"
needs = ["Filters for GitHub Actions"]
secrets = ["SVN_USERNAME", "SVN_PASSWORD"]
env = {
SLUG = "eight-day-week-print-workflow"
}
}
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ phpunit.xml
.idea
.sass-cache
*.map
release
release
vendor
.DS_Store
Binary file added .wordpress-org/banner-1544x500-rtl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/banner-1544x500.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/banner-772x250-rtl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/banner-772x250.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/icon-128x128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/icon-256x256.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/screenshot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/screenshot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/screenshot-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/screenshot-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 17 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,23 @@

All notable changes to this project will be documented in this file, per [the Keep a Changelog standard](http://keepachangelog.com/).

## [Unreleased]

## [1.1.0] - 2019-07-26
### Added
- German translation files (props @adamsilverstein, @maryisdead via #31)
- Plugin banner and icon images (props @chriswallace via #30)

### Updated
- Update dependencies in `package.json` and `composer.json` to current versions (props @adamsilverstein via #28)

### Fixed
- DateTimeZone setup: fall back to `gmt_offset` (props @adamsilverstein, @Jared-Williams via #32)
- PHP notices w/PHP 5.6 and fatals with PHP 7.2/3 (props @adamsilverstein via #28)

## [1.0.0] - 2015-11-16
- Initial Release

[1.0.0]: https://plugins.trac.wordpress.org/changeset/1287245/eight-day-week-print-workflow
[Unreleased]: https://github.com/10up/eight-day-week/compare/master...develop
[1.1.0]: https://github.com/10up/eight-day-week/compare/9057a7f...1.1.0
[1.0.0]: https://github.com/10up/eight-day-week/commit/9057a7f310068676ef8a15e0ba0a395273f1cb98
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,16 @@ For more on how 10up writes and manages code, check out our [10up Engineering Be
## 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 `master` contains the corresponding stable development version. Always work on the `develop` branch and open up PRs against `develop`.

## Release instructions

1. Branch: Starting from `develop`, cut a release branch named `release/X.Y.Z` for your changes.
2. Version bump: Bump the version number in `eight-day-week.php` and `readme.txt` if it does not already reflect the version being released.
3. Changelog: Add/update the changelog in both `readme.txt` and `CHANGELOG.md`
4. Readme updates: Make any other readme changes as necessary. `CHANGELOG.md` and `README.md` are geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different.
5. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.gitattributes`.
6. Merge: Make a non-fast-forward merge from your release branch to `develop`, then do the same for `develop` into `master`. `master` contains the stable development version.
7. Test: While still on the `master` branch, test for functionality locally. If all is well, push to GitHub.
8. Release: Create a [new release](https://github.com/10up/eight-day-week/releases/new), naming the tag and the release with the new version number. Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the milestone (e.g. `https://github.com/10up/eight-day-week/milestone/2?closed=1`). Close the milestone. If any open PRs which were milestoned for the new release do not make it into the release, update their milestone.
9. SVN: Wait for the [GitHub Action](https://github.com/10up/eight-day-week/actions) to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
10. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/eight-day-week-print-workflow/. This may take a few minutes.
4 changes: 4 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ This file is a work-in-progress attempt to display the various contributors to E
- [Jeff Sternberg](https://github.com/sternb0t)
- [Anthony Castro](https://github.com/anthony-j-castro)
- [Josh Pollock](https://github.com/Shelob9)
- [Adam Silverstein](https://github.com/adamsilverstein)
- [Matthias Wehrlein](https://github.com/maryisdead)
- [Chris Wallace](https://github.com/chriswallace)
- [Jared Williams](https://github.com/Jared-Williams)
28 changes: 14 additions & 14 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ module.exports = function( grunt ) {
'Gruntfile.js',
'assets/js/src/**/*.js',
'assets/js/test/**/*.js'
]
]
},
uglify: {
all: {
Expand All @@ -28,42 +28,42 @@ module.exports = function( grunt ) {
},
options: {
mangle: {
except: ['jQuery']
reserved: ['jQuery']
}
}
}
},

sass: {
all: {
files: {
'assets/css/style.css': 'assets/css/sass/style.scss'
}
}
},


autoprefixer: {
dist: {
options: {
browsers: [ 'last 1 version', '> 1%', 'ie 8' ]
},
files: {
files: {
'assets/css/style.css': [ 'assets/css/style.css' ]
}
}
},

cssmin: {
options: {
processImport: false
},
minify: {
expand: true,
cwd: 'assets/css/',

cwd: 'assets/css/',
src: ['style.css'],

dest: 'assets/css/',
ext: '.min.css'
}
Expand Down Expand Up @@ -121,7 +121,7 @@ module.exports = function( grunt ) {
'!phpunit.xml.dist'
],
dest: './release/<%= pkg.version %>/'
}
}
},
compress: {
main: {
Expand All @@ -133,7 +133,7 @@ module.exports = function( grunt ) {
cwd: './release/<%= pkg.version %>/',
src: ['**/*'],
dest: 'eight-day-week/'
}
}
},
wp_readme_to_markdown: {
target: {
Expand All @@ -143,10 +143,10 @@ module.exports = function( grunt ) {
}
}
} );

// Load tasks
require('load-grunt-tasks')(grunt);

// Register tasks
grunt.registerTask( 'default', ['jshint', 'concat', 'uglify', 'sass', 'autoprefixer', 'cssmin' ] );

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

> Optimize publication workflows by using WordPress as your print CMS. Eight Day Week provides a set of tools to manage your print workflow directly in your WordPress dashboard–right where your posts are! Primarily, it offers an interface to group, label, and manage the workflow status of posts in a printed "Issue".
Expand All @@ -20,6 +20,8 @@
- Add and order sections, and articles within sections
- Assign article statuses specific to your print workflow

![The Print Issue editor, showing the sections and contained articles, as well as several modules at play.](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-2.png)

### Limit access to Print Roles

Two custom roles are added by this plugin to best model a real-world print team.
Expand All @@ -31,6 +33,8 @@ Two custom roles are added by this plugin to best model a real-world print team.

- Circumvents the post locking feature by offering a read-only view of a print issue

![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.](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-4.png)

### XML Export to InDesign

- Export XML files specifically formatted for import into InDesign
Expand Down Expand Up @@ -59,7 +63,7 @@ Issue Publication
Issue Status
Any of these can be disabled by returning a falsey value from the following filter format:
`add_filter( 'Eight_Day_Week\Plugins\load_$plugin', '__return_false' );`
The `$plugin` value is a slug version of the plugin nam e, i.e. article-byline
The `$plugin` value is a slug version of the plugin name, i.e. article-byline.

### Article Table

Expand All @@ -75,33 +79,18 @@ Sample usage:
return implode( ', ', wp_list_pluck( my_get_post_authors_function( $post ), 'display_name' ) );
}

![Further down the page of the Print Issue Editor, showing buttons to add sections & articles. Each section has a Save button for convenience; all Save buttons simply save the entire Issue.](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-3.png)

### Print Issue Table

The information displayed in the list of Print Issues is filterable. Custom columns can be added via the following filter:
`Eight_Day_Week\Print_Issue_Columns\pi_columns`
Note that this is a convenience filter, the base filter is `manage_edit-print-issue_columns`
See `includes/functions/print-issue-columns.php` for sample usage.

### Article Export
`Eight_Day_Week\Print_Issue_Columns\pi_columns`. Note that this is a convenience filter, the base filter is `manage_edit-print-issue_columns`. See `includes/functions/print-issue-columns.php` for sample usage.

The export of posts in a Print Issue is highly customizeable, from the file name of the zip, to the file name of the individual files, to the contents of the files themselves.
The best reference would be to read through `includes/functions/plugins/article-export.php`.
[Here's](https://gist.github.com/joshlevinson/4a2c3ed78b21b3c54eba) a few examples used on the *Observer*.

## Screenshots

##### 1. The Print Issue list table
![The Print Issue list table](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-1.png)

##### 2. The Print Issue editor, showing the sections and contained articles, as well as several modules at play.
![The Print Issue editor, showing the sections and contained articles, as well as several modules at play.](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-2.png)

##### 3. Further down the page of the Print Issue Editor, showing buttons to add sections & articles. Each section has a Save button for convenience; all Save buttons simply save the entire Issue.
![Further down the page of the Print Issue Editor, showing buttons to add sections & articles. Each section has a Save button for convenience; all Save buttons simply save the entire Issue.](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-3.png)
### Article Export

##### 4. 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.
![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.](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-4.png)
The export of posts in a Print Issue is highly customizeable, from the file name of the zip, to the file name of the individual files, to the contents of the files themselves. The best reference would be to read through `includes/functions/plugins/article-export.php`. [Here's](https://gist.github.com/joshlevinson/4a2c3ed78b21b3c54eba) a few examples used on the *Observer*.

## Support Level

Expand Down
2 changes: 1 addition & 1 deletion assets/css/style.min.css

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

Loading

0 comments on commit f3dc82a

Please sign in to comment.