Skip to content
This repository was archived by the owner on Nov 10, 2022. It is now read-only.

Allow readme.md generation comment to be skipped #269

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Allow readme.md generation comment to be skipped #269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f054cd
Allow readme.md generation comment to be skipped
westonruter Jan 21, 2018
5e89e97
Use absolute URL for github assets in readme.md
westonruter Jan 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions class-wordpress-readme-parser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/)(.+?)\]#',
Expand All @@ -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 ) ) {
Expand All @@ -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 {
Expand All @@ -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;
Expand Down Expand Up @@ -172,11 +175,14 @@ function ( $tag ) {
}

// Render metadata
$markdown = "<!-- DO NOT EDIT THIS FILE; it is auto-generated from readme.txt -->\n";
$markdown = '';
if ( empty( $params['skip_generation_notice'] ) ) {
$markdown .= "<!-- DO NOT EDIT THIS FILE; it is auto-generated from readme.txt -->\n";
}
$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 );
Expand Down
8 changes: 8 additions & 0 deletions generate-markdown-readme
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,15 @@ 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'] );
}
if ( file_exists( $readme_root . '/.travis.yml' ) ) {
if ( isset( $travis_ci_pro_badge ) ) {
Expand Down