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.

Sign up for GitHub

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

fix: The URL to info about README generation was broken. #37

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: The URL to info about README generation was broken. #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions github-actions/oss-readme-template/__tests__/readme.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ For more info, visit our website at [https://gomomento.com](https://gomomento.co
});
})
.toThrowError(`README template does not conform to Momento OSS requirements:
{"lineNumber":2,"ruleNames":["must-include-oss-headers"],"ruleDescription":"Template must begin with OSS Header and end with OSS Footer","ruleInformation":"https://github.com/momentohq/standards-and-practices/github-actions/oss-readme-generator","errorDetail":"Expected template file to begin with {{ ossHeader }}, on a line by itself.","errorContext":null,"errorRange":null,"fixInfo":null}
{"lineNumber":2,"ruleNames":["must-include-oss-headers"],"ruleDescription":"Template must begin with OSS Header and end with OSS Footer","ruleInformation":"https://github.com/momentohq/standards-and-practices/github-actions/oss-readme-generator","errorDetail":"Expected template file to end with {{ ossFooter }}, on a line by itself.","errorContext":null,"errorRange":null,"fixInfo":null}`);
{"lineNumber":2,"ruleNames":["must-include-oss-headers"],"ruleDescription":"Template must begin with OSS Header and end with OSS Footer","ruleInformation":"https://github.com/momentohq/standards-and-practices/tree/main/github-actions/oss-readme-template","errorDetail":"Expected template file to begin with {{ ossHeader }}, on a line by itself.","errorContext":null,"errorRange":null,"fixInfo":null}
{"lineNumber":2,"ruleNames":["must-include-oss-headers"],"ruleDescription":"Template must begin with OSS Header and end with OSS Footer","ruleInformation":"https://github.com/momentohq/standards-and-practices/tree/main/github-actions/oss-readme-template","errorDetail":"Expected template file to end with {{ ossFooter }}, on a line by itself.","errorContext":null,"errorRange":null,"fixInfo":null}`);
});

const VALID_TEMPLATE_CONTENTS = fs
Expand Down
4 changes: 2 additions & 2 deletions github-actions/oss-readme-template/dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ exports.mustIncludeOssHeaders = {
names: ['must-include-oss-headers'],
description: 'Template must begin with OSS Header and end with OSS Footer',
tags: ['momento-oss'],
information: new URL('https://github.com/momentohq/standards-and-practices/github-actions/oss-readme-generator'),
information: new URL('https://github.com/momentohq/standards-and-practices/tree/main/github-actions/oss-readme-template'),
function: (params, onError) => {
const firstThreeTokens = params.tokens.slice(0, 3);
verifyTokens(firstThreeTokens, ossHeaderTag, onError, 'Expected template file to begin with', firstThreeTokens[0].lineNumber);
Expand Down Expand Up @@ -149,7 +149,7 @@ exports.verifySdkSectionHeaders = {
names: ['expected-sdk-section-headers'],
description: 'SDK must have required section headers',
tags: ['momento-oss'],
information: new URL('https://github.com/momentohq/standards-and-practices/github-actions/oss-readme-generator'),
information: new URL('https://github.com/momentohq/standards-and-practices/tree/main/github-actions/oss-readme-template'),
function: (params, onError) => {
const headers = [];
let insideHeaderOpenTag = false;
Expand Down
2 changes: 1 addition & 1 deletion github-actions/oss-readme-template/src/markdownlint-rules/must-include-oss-headers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const mustIncludeOssHeaders: markdownlint.Rule = {
description: 'Template must begin with OSS Header and end with OSS Footer',
tags: ['momento-oss'],
information: new URL(
'https://github.com/momentohq/standards-and-practices/github-actions/oss-readme-generator'
'https://github.com/momentohq/standards-and-practices/tree/main/github-actions/oss-readme-template'
),
function: (params, onError) => {
const firstThreeTokens = params.tokens.slice(0, 3);
Expand Down
2 changes: 1 addition & 1 deletion github-actions/oss-readme-template/src/markdownlint-rules/verify-sdk-section-headers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const verifySdkSectionHeaders: markdownlint.Rule = {
description: 'SDK must have required section headers',
tags: ['momento-oss'],
information: new URL(
'https://github.com/momentohq/standards-and-practices/github-actions/oss-readme-generator'
'https://github.com/momentohq/standards-and-practices/tree/main/github-actions/oss-readme-template'
),
function: (params, onError) => {
const headers: Array<HeaderWithLineNumber> = [];
Expand Down