From 5f054cdd4d4a65e99d70d4aff3e939bacbad8160 Mon Sep 17 00:00:00 2001 From: Weston Ruter Date: Sat, 20 Jan 2018 18:15:43 -0800 Subject: [PATCH 1/2] Allow readme.md generation comment to be skipped --- class-wordpress-readme-parser.php | 5 ++++- generate-markdown-readme | 1 + 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/class-wordpress-readme-parser.php b/class-wordpress-readme-parser.php index d334479..414ad5c 100644 --- a/class-wordpress-readme-parser.php +++ b/class-wordpress-readme-parser.php @@ -172,7 +172,10 @@ function ( $tag ) { } // Render metadata - $markdown = "\n"; + $markdown = ''; + if ( empty( $params['skip_generation_notice'] ) ) { + $markdown .= "\n"; + } $markdown .= sprintf( "# %s\n", $this->title ); $markdown .= "\n"; if ( file_exists( $params['assets_dir'] . '/banner-1544x500.png' ) ) { diff --git a/generate-markdown-readme b/generate-markdown-readme index e7269d1..4289b60 100755 --- a/generate-markdown-readme +++ b/generate-markdown-readme @@ -90,6 +90,7 @@ try { if ( isset( $env_vars['ASSETS_DIR'] ) ) { $md_args['assets_dir'] = $env_vars['ASSETS_DIR']; } + $md_args['skip_generation_notice'] = ! empty( $env_vars['SKIP_README_MD_GENERATION_COMMENT'] ); } if ( file_exists( $readme_root . '/.travis.yml' ) ) { if ( isset( $travis_ci_pro_badge ) ) { From 5e89e973725eb4e45f4168238309d2eb2caf3bb8 Mon Sep 17 00:00:00 2001 From: Weston Ruter Date: Sat, 20 Jan 2018 21:51:18 -0800 Subject: [PATCH 2/2] Use absolute URL for github assets in readme.md --- class-wordpress-readme-parser.php | 9 ++++++--- generate-markdown-readme | 7 +++++++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/class-wordpress-readme-parser.php b/class-wordpress-readme-parser.php index 414ad5c..7db3ba4 100644 --- a/class-wordpress-readme-parser.php +++ b/class-wordpress-readme-parser.php @@ -92,6 +92,8 @@ function __construct( $args = array() ) { function to_markdown( $params = array() ) { $that = $this; + $github_assets_url = ! empty( $params['github_assets_url'] ) ? $params['github_assets_url'] : $params['assets_dir']; + $general_section_formatter = function ( $body ) use ( $params ) { $body = preg_replace( '#\[youtube\s+(?:https?://www\.youtube\.com/watch\?v=|https?://youtu\.be/)(.+?)\]#', @@ -109,7 +111,7 @@ function to_markdown( $params = array() ) { // Parse sections $section_formatters = array( - 'Screenshots' => function ( $body ) use ( $that, $params ) { + 'Screenshots' => function ( $body ) use ( $that, $params, $github_assets_url ) { $body = trim( $body ); $new_body = ''; if ( ! preg_match_all( '/^\d+\. (.+?)\s*$/m', $body, $screenshot_matches, PREG_SET_ORDER ) ) { @@ -119,6 +121,7 @@ function to_markdown( $params = array() ) { $img_extensions = array( 'jpg', 'gif', 'png' ); foreach ( $img_extensions as $ext ) { $filepath = sprintf( '%s/screenshot-%d.%s', $params['assets_dir'], $i + 1, $ext ); + $fileurl = sprintf( '%s/screenshot-%d.%s', $github_assets_url, $i + 1, $ext ); if ( file_exists( dirname( $that->path ) . DIRECTORY_SEPARATOR . $filepath ) ) { break; } else { @@ -132,7 +135,7 @@ function to_markdown( $params = array() ) { $screenshot_name = $screenshot_match[1]; $new_body .= sprintf( "### %s\n", $screenshot_name ); $new_body .= "\n"; - $new_body .= sprintf( "![%s](%s)\n", $screenshot_name, $filepath ); + $new_body .= sprintf( "![%s](%s)\n", $screenshot_name, $fileurl ); $new_body .= "\n"; } return $new_body; @@ -179,7 +182,7 @@ function ( $tag ) { $markdown .= sprintf( "# %s\n", $this->title ); $markdown .= "\n"; if ( file_exists( $params['assets_dir'] . '/banner-1544x500.png' ) ) { - $markdown .= "![Banner]({$params['assets_dir']}/banner-1544x500.png)"; + $markdown .= "![Banner]({$github_assets_url}/banner-1544x500.png)"; $markdown .= "\n"; } $markdown .= sprintf( "%s\n", $this->short_description ); diff --git a/generate-markdown-readme b/generate-markdown-readme index 4289b60..b2d134d 100755 --- a/generate-markdown-readme +++ b/generate-markdown-readme @@ -89,6 +89,13 @@ try { } if ( isset( $env_vars['ASSETS_DIR'] ) ) { $md_args['assets_dir'] = $env_vars['ASSETS_DIR']; + + $md_args['github_assets_url'] = sprintf( + 'https://github.com/%s/raw/%s/%s', + $github_account_repo, + isset( $env_vars['DEFAULT_BASE_BRANCH'] ) ? $env_vars['DEFAULT_BASE_BRANCH'] : 'master', + $env_vars['ASSETS_DIR'] + ); } $md_args['skip_generation_notice'] = ! empty( $env_vars['SKIP_README_MD_GENERATION_COMMENT'] ); }