The latest articles on DEV Community by PuZZleDucK (@puzzleduck). https://dev.to/puzzleduck https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F248173%2F34c294ec-796d-4214-9cfc-c9bd7ac1e645.jpeg https://dev.to/puzzleduck en PuZZleDucK Fri, 14 Aug 2020 17:43:56 +0000 https://dev.to/puzzleduck/the-4-letter-fails-action-143e https://dev.to/puzzleduck/the-4-letter-fails-action-143e <h3> 4 Letter Fails </h3> <p>If your README.md contains any four-letter-words then "4 Letter Fails" will halt the workflow. This GitHub Action checks your README.md for profanity and fails if any are found.</p> <h3> Submission Category: </h3> <p>Wacky Wildcards</p> <h3> Yaml File or Link to Code </h3> <p>GitHub Repository: </p> <div class="ltag-github-readme-tag"> <div class="readme-overview"> <h2> <img src="https://res.cloudinary.com/practicaldev/image/fetch/s--vJ70wriM--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://practicaldev-herokuapp-com.freetls.fastly.net/assets/github-logo-ba8488d21cd8ee1fee097b8410db9deaa41d0ca30b004c0c63de0a479114156f.svg" alt="GitHub logo"> <a href="https://github.com/PuZZleDucK"> PuZZleDucK </a> / <a href="https://github.com/PuZZleDucK/4-Letter-Fails"> 4-Letter-Fails </a> </h2> <h3> This GitHub Action checks your README.md for profanity and fails if any is found </h3> </div> <div class="ltag-github-body"> <div id="readme" class="md"> <h1> 4 Letter Fails</h1> <p>This GitHub Action checks your README.md for profanity and fails if any is found.</p> <h3> Using 4 Letter Fails</h3> <pre><code>steps: - uses: actions/4-Letter-Fails@v1 </code></pre> <h3> Developing</h3> <ul> <li>Clone repo: <code>git clone git@github.com:PuZZleDucK/4-Letter-Fails.git</code> </li> </ul> <h3> Badges</h3> <p>You can create a badge for your profanity filter by... Example badge here</p> <h3> GitHub Actions Hackathon</h3> <p>This is also my entry for the GitHub Actions For Open Source hackathon on DEV.to</p> <h3> Release Management</h3> <ul> <li>Create &amp; validate a release branch: <code>git flow release start v1</code> </li> <li>Tag release: <code>git tag -a v1.0.0 -m "Release 1.0.0 - Slanderous Skink"</code> </li> <li>Create major release on GitHub</li> <li>Move the major version tag (such as v1, v2) to the latest point release</li> <li>Introduce a new major version tag (if needed)</li> </ul> <h3> Releases - Changelog</h3> <p>Version 1.0.0 - Slanderous Skink</p> <ul> <li>Initial release</li> </ul> <h3> Current Limitations</h3> <ul> <li>Only checks README.md</li> <li>fixed profanity list</li> </ul> </div> </div> <br> <div class="gh-btn-container"><a class="gh-btn" href="https://github.com/PuZZleDucK/4-Letter-Fails">View on GitHub</a></div> <br> </div> <br> <p>Marketplace: <a href="https://github.com/marketplace/actions/4-letter-fails">https://github.com/marketplace/actions/4-letter-fails</a></p> <h3> Additional Resources / Info </h3> <p>Under the hood it's making use of profanityfilter: <a href="https://github.com/areebbeigh/profanityfilter">https://github.com/areebbeigh/profanityfilter</a> and a custom action</p> <p>Currently having problems trying to use the action in other repositories. It's published on the market, but when I use it I always get <code>An action could not be found at the URI 'https://api.github.com/repos/actions/4-Letter-Fails/tarball/v1'</code></p> <p>Author: Ben Minerds (PuZZleDucK)</p> actionshackathon