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

fix: correct indentation on documentation #623

Merged
merged 3 commits into from
Mar 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
CHANGELOG
=====================================
| March 22, 2022: fix: pass comment instance to removeErrorComments `#626 <https://github.com/mergeability/mergeable/pull/626>`_
| February 24, 2022: fix: correct indentation on documentation `#623 <https://github.com/mergeability/mergeable/pull/623>`_
| February 8, 2022: feat: Allow all option on must_include and must_include inside changeset validator `#611 <https://github.com/mergeability/mergeable/pull/611>`_
| February 6, 2022: feat: Add commit_title and commit_message options to merge action so the merge commit can be customized based on PR content `#612 <https://github.com/mergeability/mergeable/pull/612>`_
| December 12, 2021: feat: Add support for status events to baseRef validator `#395 <https://github.com/mergeability/mergeable/issues/395#issuecomment-991904249>`_
Expand Down
64 changes: 32 additions & 32 deletions docs/recipes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -236,36 +236,36 @@ Checks that the PR's draft state is false before running actions.

::

version: 2
mergeable:
- when: pull_request.*
validate:
- do: commit
message:
regex: '^(AB#[0-9]{1,})' #check if all commit messages begin with an AzDO Work Item
pass:
- do: comment
payload:
body: >
<h2>Successfully checked for Azure Work Item IDs in commits</h2>
<h3>All commits in your PR have Azure Board Work Item IDs. Ready for Review!</h3>
:+1:
- do: labels
add: 'Ready for Review'
fail:
- do: comment
payload:
body: >
:warning:
<h2>Azure Boards Work Item IDs missing in commits</h2>
<h3>Some commits messages were found not having the Azure Boards Work Item ID (AB#1234).</h3>
<h3>We will close this PR for now.</h3>
<h3>To resolve, please do one of the following</h3>
<ul>
<li>Identify your Azure Boards Work Item ID and <a href="https://gist.github.com/nepsilon/156387acf9e1e72d48fa35c4fabef0b4">amend your commits</a>. Then re-open the PR</li>
<li>In case you do not have a Work Item ID to reference, please discuss with your reviewer(s) for alternate options</li>
</ul>
- do: labels
add: 'Non-Compliant'
- do: close
version: 2
mergeable:
- when: pull_request.*
validate:
- do: commit
message:
regex: '^(AB#[0-9]{1,})' #check if all commit messages begin with an AzDO Work Item
pass:
- do: comment
payload:
body: >
<h2>Successfully checked for Azure Work Item IDs in commits</h2>
<h3>All commits in your PR have Azure Board Work Item IDs. Ready for Review!</h3>
:+1:
- do: labels
add: 'Ready for Review'
fail:
- do: comment
payload:
body: >
:warning:
<h2>Azure Boards Work Item IDs missing in commits</h2>
<h3>Some commits messages were found not having the Azure Boards Work Item ID (AB#1234).</h3>
<h3>We will close this PR for now.</h3>
<h3>To resolve, please do one of the following</h3>
<ul>
<li>Identify your Azure Boards Work Item ID and <a href="https://gist.github.com/nepsilon/156387acf9e1e72d48fa35c4fabef0b4">amend your commits</a>. Then re-open the PR</li>
<li>In case you do not have a Work Item ID to reference, please discuss with your reviewer(s) for alternate options</li>
</ul>
- do: labels
add: 'Non-Compliant'
- do: close