Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make README.md canonical, generating readme.txt at build time #400

Merged
merged 9 commits into from
Mar 9, 2021

Conversation

westonruter
Copy link
Collaborator

@westonruter westonruter commented Jan 25, 2021

Instead of maintaining readme.txt and synchronizing it to readme.md, we can just keep the markdown version alone and then generate the readme.txt at build time. Based on learnings from ampproject/amp-wp#5807 and ampproject/amp-wp#5815.

Also eliminates xwp/wp-dev-lib dependency, which is obsolete now that we're no longer using generate-markdown-readme nor the check-diff.sh (since lint-staged was added in #354).

@westonruter westonruter added this to the 0.7 milestone Jan 25, 2021
@westonruter westonruter changed the title Eliminate readme.txt in favor of README.md Make README.md canonical, generating readme.txt at build time Jan 26, 2021
@codecov-io
Copy link

codecov-io commented Jan 26, 2021

Codecov Report

Merging #400 (a3dcda1) into develop (f0138b1) will decrease coverage by 0.93%.
The diff coverage is 0.00%.

Impacted file tree graph

@@              Coverage Diff              @@
##             develop     #400      +/-   ##
=============================================
- Coverage      24.19%   23.26%   -0.94%     
  Complexity       364      364              
=============================================
  Files             55       56       +1     
  Lines           1872     1947      +75     
=============================================
  Hits             453      453              
- Misses          1419     1494      +75     
Flag Coverage Δ Complexity Δ
php 23.26% <0.00%> (-0.94%) 0.00 <0.00> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ Complexity Δ
bin/transform-readme.php 0.00% <0.00%> (ø) 0.00 <0.00> (?)
bin/verify-version-consistency.php 0.00% <0.00%> (ø) 0.00 <0.00> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f0138b1...a3dcda1. Read the comment docs.

@westonruter westonruter requested a review from amedina January 26, 2021 19:03
…ove/readme.txt

* 'develop' of github.com:GoogleChromeLabs/pwa-wp: (26 commits)
  Bump @wordpress/plugins from 2.24.6 to 2.24.7
  Bump @wordpress/plugins from 2.24.5 to 2.24.6
  Bump eslint-plugin-jsdoc from 32.1.0 to 32.2.0
  Bump eslint from 7.20.0 to 7.21.0
  Bump eslint-plugin-jsdoc from 32.0.1 to 32.1.0
  Bump eslint-plugin-jsdoc from 32.0.0 to 32.0.1
  Bump eslint from 7.19.0 to 7.20.0
  Bump @wordpress/eslint-plugin from 8.0.1 to 8.0.2
  Bump @wordpress/plugins from 2.24.2 to 2.24.5
  Bump phpcompatibility/phpcompatibility-wp from 2.1.0 to 2.1.1
  Bump eslint-plugin-jsdoc from 31.6.0 to 32.0.0
  Bump @wordpress/scripts from 13.0.1 to 13.0.3
  Bump lint-staged from 10.5.3 to 10.5.4
  Use wp_robots() to prevent indexing the error template on WP≥5.7
  Bump eslint from 7.18.0 to 7.19.0
  Bump eslint-plugin-jsdoc from 31.4.0 to 31.6.0
  Bump @wordpress/eslint-plugin from 8.0.0 to 8.0.1
  Bump @wordpress/scripts from 13.0.0 to 13.0.1
  Bump eslint-plugin-jsdoc from 31.3.3 to 31.4.0
  Bump eslint-plugin-jsdoc from 31.3.2 to 31.3.3
  ...
@westonruter westonruter merged commit 209d0db into develop Mar 9, 2021
@westonruter westonruter deleted the remove/readme.txt branch March 9, 2021 21:37
@pooja-muchandikar
Copy link

QA Passed ✅

readme.txt is getting generated at build time as expected.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants