Skip to content

Remove release dependency on markdown link check#762

Closed
MikeMcC399 wants to merge 1 commit into
cypress-io:masterfrom
MikeMcC399:fix/move-markdown-check
Closed

Remove release dependency on markdown link check#762
MikeMcC399 wants to merge 1 commit into
cypress-io:masterfrom
MikeMcC399:fix/move-markdown-check

Conversation

@MikeMcC399

Copy link
Copy Markdown
Collaborator

This PR resolves issue #717 "Bad external links may block release".

In .github/workflows/main.yml npm run check:markdown is removed from the build-and-test job and placed it inside a new independent job check-markdown-links inside the same workflow.

Verification

Error case

In a copy of the cypress-io/github-action/ repo:

  1. introduce a link error into README.md
  2. execute npm run check:markdown and verify the test fails
  3. simulate a release and check that the markdown failure does not prevent a releas

Non-error case

As above except with no markdown link error present.

Production case

Monitor production when a commit with fix:, feat: or perf: in the title is merged into the master branch and check that a release takes place correctly.

@MikeMcC399

Copy link
Copy Markdown
Collaborator Author

This is in draft state until I complete testing on it.

Runs 4053044057 shows it running successfully as an independent job.

image

It includes the commit flag fix: so that it will cause a patch release when it is merged, otherwise it will not be fully tested.

@MikeMcC399

Copy link
Copy Markdown
Collaborator Author

If there is a markdown error then the workflow shows as having failed although the release job was successful. This is expected, however I think it makes more sense to separate out the check markdown into a new workflow which only checks the markdown, so I will close this PR and resubmit.

This will make the results of the checks clearer and if there is a markdown error a PR can still be manually merged if this is justified.

@MikeMcC399

Copy link
Copy Markdown
Collaborator Author

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.

1 participant