github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: preserve links to master version of API from README.md (#3197)

Browse Source 
One of our checks makes sure all links from README.md to API.md
point to the last-released version of the API.

This sometimes doesn't work: when we refer to a section
in api.md that is just added, we should be able to reference
the "master" version of the api.md

This patch:
- teaches the doclint check to keep links to tip-of-tree version
  of api.md in README.md intact.
- starts refering to tip-of-tree version of api.md in `puppeter-core` section
This commit is contained in:
Andrey Lushnikov 2018-09-05 20:33:04 +01:00 committed by GitHub
parent 3364659cca
commit 7db4f0f798
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -51,7 +51,7 @@ npm i puppeteer-core
`puppeteer-core` is intended to be a lightweight version of puppeteer for launching an existing browser installation or for connecting to a remote one. `puppeteer-core` is intended to be a lightweight version of puppeteer for launching an existing browser installation or for connecting to a remote one.
See [puppeteer vs puppeteer-core](https://github.com/GoogleChrome/puppeteer/blob/v1.7.0/docs/api.md#puppeteer-vs-puppeteer-core). See [puppeteer vs puppeteer-core](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteer-vs-puppeteer-core).
### Usage ### Usage

2
utils/doclint/preprocessor/index.js
View File

@ -18,7 +18,7 @@ const Message = require('../Message');
module.exports.ensureReleasedAPILinks = function(sources, version) { module.exports.ensureReleasedAPILinks = function(sources, version) {
// Release version is everything that doesn't include "-". // Release version is everything that doesn't include "-".
const apiLinkRegex = /https:\/\/github.com\/GoogleChrome\/puppeteer\/blob\/[^/]*\/docs\/api.md/ig; const apiLinkRegex = /https:\/\/github.com\/GoogleChrome\/puppeteer\/blob\/v[^/]*\/docs\/api.md/ig;
const lastReleasedAPI = `https://github.com/GoogleChrome/puppeteer/blob/v${version.split('-')[0]}/docs/api.md`; const lastReleasedAPI = `https://github.com/GoogleChrome/puppeteer/blob/v${version.split('-')[0]}/docs/api.md`;
const messages = []; const messages = [];

14
utils/doclint/preprocessor/test.js
View File

@ -28,7 +28,7 @@ const {expect} = new Matchers();
describe('ensureReleasedAPILinks', function() { describe('ensureReleasedAPILinks', function() {
it('should work with non-release version', function() { it('should work with non-release version', function() {
const source = new Source('doc.md', ` const source = new Source('doc.md', `
[API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-page) [API](https://github.com/GoogleChrome/puppeteer/blob/v1.1.0/docs/api.md#class-page)
`); `);
const messages = ensureReleasedAPILinks([source], '1.3.0-post'); const messages = ensureReleasedAPILinks([source], '1.3.0-post');
expect(messages.length).toBe(1); expect(messages.length).toBe(1);
@ -40,7 +40,7 @@ describe('ensureReleasedAPILinks', function() {
}); });
it('should work with release version', function() { it('should work with release version', function() {
const source = new Source('doc.md', ` const source = new Source('doc.md', `
[API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-page) [API](https://github.com/GoogleChrome/puppeteer/blob/v1.1.0/docs/api.md#class-page)
`); `);
const messages = ensureReleasedAPILinks([source], '1.3.0'); const messages = ensureReleasedAPILinks([source], '1.3.0');
expect(messages.length).toBe(1); expect(messages.length).toBe(1);
@ -50,6 +50,16 @@ describe('ensureReleasedAPILinks', function() {
[API](https://github.com/GoogleChrome/puppeteer/blob/v1.3.0/docs/api.md#class-page) [API](https://github.com/GoogleChrome/puppeteer/blob/v1.3.0/docs/api.md#class-page)
`); `);
}); });
it('should keep master links intact', function() {
const source = new Source('doc.md', `
[API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-page)
`);
const messages = ensureReleasedAPILinks([source], '1.3.0');
expect(messages.length).toBe(0);
expect(source.text()).toBe(`
[API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-page)
`);
});
}); });
describe('runCommands', function() { describe('runCommands', function() {