Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/funbeedev/checkchangedfileshelper

GitHub Action to detect all changed files pushed to repo and perform a check. Copy and configure to your needs.
https://github.com/funbeedev/checkchangedfileshelper

Last synced: about 1 month ago
JSON representation

GitHub Action to detect all changed files pushed to repo and perform a check. Copy and configure to your needs.

Awesome Lists containing this project

README 

        
#  Check Changed Files Helper ✔️



![Check Changed Files Helper](https://res.cloudinary.com/practicaldev/image/fetch/s--NNZjm2uc--/c_imagga_scale,f_auto,fl_progressive,h_420,q_auto,w_1000/https://dev-to-uploads.s3.amazonaws.com/uploads/articles/q5483y5sadyg3nqf3gu8.png)



##  📜 About 📜



Submitted for the GitHub Actions Hackathon on DEV. [View the DEV post submission](https://dev.to/funbeedev/check-changed-files-helper-github-actions-4dao).



[GitHub Actions](https://github.com/features/actions) are a feature provided by GitHub as a way to automate workflows useful for managing repositories.



`Check Changed Files Helper` is a GitHub Action workflow that performs a check on changes made to source files pushed to a repository. Customise this workflow to suit your own repository needs.



This repo shows an example of how GitHub Action workflows can be used to automate checks on files changed in the repo.



**This project relies on the [`Get Changed Files`](https://github.com/marketplace/actions/get-changed-files) Action available on the GitHub marketplace**.  

This Action provides all added, renamed and modified files as a JSON file within the runner filesystem. When a file or multiple files are changed on the repo, it will identify and list each in the JSON file.



`Check Changed Files Helper` takes each changed file and performs a check to execute any recognised source file types. A handy way to automate checks of files submitted to your repository!



Note: The example workflow structure provided may not suit every repository. However, it can act as a starting point to get you thinking about workflows to automate checks on pushed changes.



## 💻 How to use 💻



The files needed to run this workflow are placed under the repo path `.github/workflows`. Fork this repo or copy these files to start customising for your own use.



`auto-check-changed-files.yml`: YAML file containing the GitHub Actions workflow. This will setup any necessary dependencies and use the [`Get Changed Files`](https://github.com/marketplace/actions/get-changed-files) Action to generate a JSON containing all files changed on the repository with every push to the `main` branch. Following this, the `auto-check-changed-files.sh` bash script is executed.



`auto-check-changed-files.sh`: Bash script containing custom check instructions. It scans through each changed file pushed to the repository and performs a basic execution check on each file. Edit this script to extend the recognised file types and checks to be performed.



## ⚙️ Configure to suit your needs ⚙️

- Play around by forking this repo and pushing changes (e.g. adding, renaming or modifying) to the source files.

- The GitHub Actions workflow will trigger and perform a check on each changed file.

- Sample checks are provided for following file types:`.c .py .js .sh`. The sample check is to simply execute the file type acting as a very basic sanity check on the file contents.

- Use this as a template to perform specific checks on files changed on the repository according to the file type.

- Get creative and modify the workflow YAML and bash script to suit the needs of your repository!



## ❓ Questions ❓

Create an [ISSUE](../../issues) if you have any questions, suggestions or anything else.