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

Add Github Action to link check the README #18

Open
booyaa opened this issue Oct 2, 2019 · 2 comments
Open

Add Github Action to link check the README #18

booyaa opened this issue Oct 2, 2019 · 2 comments
Labels
Milestone

Comments

@booyaa
Copy link
Owner

booyaa commented Oct 2, 2019

Acceptance criteria

  • Create a separate workflow called markdown.yml do not use an existing workflow if found.
  • Call this workflow (if possible) from the main workflow CI.yml
  • Bonus: if you can find a GitHub Action that does linting i.e. make sure it's valid Markdown/HTML. Doesn't need to be the same Action that does link checking.
@booyaa booyaa changed the title Add markdown github action to lint README Add Github Action to lint and link check the README Oct 2, 2019
@booyaa booyaa added this to the 0.5 milestone Oct 2, 2019
@lionel-faber
Copy link

Hey @booyaa
Just to confirm you are looking to add a GH action to run lint checks on the README file?

@booyaa
Copy link
Owner Author

booyaa commented Oct 2, 2019

Hey @booyaa
Just to confirm you are looking to add a GH action to run lint checks on the README file?

A link checker would be fine (there's a few actions available that do the job). I'll update issue to reflect this.

@booyaa booyaa changed the title Add Github Action to lint and link check the README Add Github Action to link check the README Oct 2, 2019
@booyaa booyaa modified the milestones: 0.5, 0.6 Oct 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants