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 expected failures files more readable #1193

Closed
butonic opened this issue Jan 11, 2021 · 2 comments · Fixed by #1348
Closed

Make expected failures files more readable #1193

butonic opened this issue Jan 11, 2021 · 2 comments · Fixed by #1348
Assignees

Comments

@butonic
Copy link
Member

butonic commented Jan 11, 2021

I'd like to make the expected failures file more prominent and reference it as the known issues.

The file currently contains a line for every failing test an a header like this:

#
# https://github.com/owncloud/ocis/issues/824 PUT request with missing parent must return status code 409
#
apiAuthWebDav/webDavPUTAuth.feature:38
#

We could markdownify this and

  • convert the failing features to markdows lists
  • link to the issue as we currently do
  • give some context

With markdown we can now

  • add a L2 or L3 header and deep link them
  • add a link to every feature to let a failing test render the url to feature file on github.
  • add a link from the README.md to the expected-failure-*.md files and encourage people to find things to work on

AFAICT grepping the features from the markdown will be a little more effort then just grep -v '#' but since it follows the list semantics grep '* ' or using sed to extract out links should do the trick.

@settings settings bot removed the QA-Team label Jan 12, 2021
@refs refs changed the title make expected failures files a markdown file Make expected failures files a markdown file Jan 13, 2021
@refs refs added Category:Defect Existing functionality is not working as expected Type:Technical-Debt Category:Feature and removed Category:Defect Existing functionality is not working as expected labels Jan 13, 2021
@exalate-issue-sync exalate-issue-sync bot changed the title Make expected failures files a markdown file Make expected failures files more readable Jan 13, 2021
@haribhandari07 haribhandari07 self-assigned this Jan 14, 2021
@haribhandari07
Copy link
Contributor

@butonic I have created a PR that converts expected failures text file in owncloud web to markdown. What do you think of this PR owncloud/web#4612 . Any suggestion is appreciated.

@phil-davis
Copy link
Contributor

Implemented in cs3org/reva by cs3org/reva#1407

expected-failures .md files are in use everywhere now.

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

Successfully merging a pull request may close this issue.

4 participants