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

Markdown results: Change folder structure and add sample data for problem query #1303

Merged
merged 3 commits into from
Apr 21, 2022

Conversation

shati-patel
Copy link
Contributor

(Based on #1302)

This PR adds sample data for a (non-path) problem query. Currently these are rendered the same, but I'll add special rendering for paths in a follow-up PR! See internal issue 👀

Checklist

N/A - internal only

  • CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
  • Issues have been created for any UI or other user-facing changes made by this pull request.
  • [Maintainers only] If this pull request makes user-facing changes that require documentation changes, open a corresponding docs pull request in the github/codeql repo and add the ready-for-doc-review label there.

@shati-patel shati-patel requested a review from a team as a code owner April 20, 2022 16:29
@shati-patel shati-patel changed the title Change folder structure and add sample data for problem query Markdown results: Change folder structure and add sample data for problem query Apr 20, 2022
import { generateMarkdown } from '../../../../src/remote-queries/remote-queries-markdown-generation';

describe('markdown generation', async function() {
it('for path-problem-query: should generate markdown file for each repo with results', async function() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: It might make sense to use nested describe blocks. So, here you would change to:

Suggested change
it('for path-problem-query: should generate markdown file for each repo with results', async function() {
describe('for path-problem-query', () => {
it('should generate markdown file for each repo with results', async function() {

And then fix indenting below. Same with the second test.

Copy link
Contributor

@aeisenberg aeisenberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestion, which you can take or leave.

To be clear, though. This PR doesn't contain any behavioural changes, only restructures the tests?

Base automatically changed from shati-patel/sharing-code-snippets to main April 21, 2022 08:17
@shati-patel shati-patel requested a review from a team as a code owner April 21, 2022 08:17
@shati-patel
Copy link
Contributor Author

Minor suggestion, which you can take or leave.

Thanks for the tidy-up tip!

To be clear, though. This PR doesn't contain any behavioural changes, only restructures the tests?

Correct! I'll have some more substantial changes in a follow-up PR 😄

@shati-patel shati-patel enabled auto-merge (rebase) April 21, 2022 08:47
@shati-patel shati-patel merged commit 908a862 into main Apr 21, 2022
@shati-patel shati-patel deleted the shati-patel/sharing-paths branch April 21, 2022 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants