A GitHub Action that adds text to the beginning (prefix) or end (suffix) of files within a specified directory.
To use this action in your project, create workflow in your project similar to this code (Note: some parts and arguments needs to be altered):
name: Generate documentation
on:
push:
jobs:
get_php_classes_list:
runs-on: ubuntu-latest
steps:
- name: Checkouting project code...
uses: actions/checkout@v4
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: 8.1
extensions: curl, gd, pdo_mysql, json, mbstring, pcre, session
ini-values: post_max_size=256M
coverage: none
tools: composer:v2
- name: Install Composer dependencies (with dev)
run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
- name: Generating documentation...
uses: impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action@v0.1.4
with:
class_root_namespace: ImpressCMS\
included_classes: ImpressCMS\**
output_path: ./docs/
- name: Prefixing docs...
uses: impresscms-dev/prefix-or-suffix-text-files-action@v2.0.0
with:
path: ./docs/
text: |
This is a test!
suffix: false
- uses: actions/upload-artifact@v4
with:
name: my-artifact
path: ./docs/This action accepts the following parameters in the workflow file (specified under the with keyword):
| Argument | Required | Default value | Description |
|---|---|---|---|
| path | Yes | Where to look for files to do operation | |
| text | Yes | Text to use for the operation | |
| suffix | No | false | If is set to true, this action will suffix files with selected text, otherwise will prefix |
Contributions to this project are welcome and appreciated! Here's how you can help:
- If you find a bug or have a suggestion for improvement, please use the issues tab
- Provide as much detail as possible including steps to reproduce, expected behavior, and actual behavior
- Use the bug report template when reporting bugs
- Fork the repository to your GitHub account by clicking the Fork button
- Clone your fork to your local machine:
git clone https://github.com/YOUR-USERNAME/prefix-or-suffix-text-files-action.git - Create a new branch for your changes:
git checkout -b feature/your-feature-name - Make your changes and test them thoroughly
- Commit your changes with clear, descriptive commit messages
- Push to your fork:
git push origin feature/your-feature-name - Create a pull request by navigating to the Pull requests tab and clicking "New pull request"
- Follow the existing code style and patterns
- Add appropriate tests for your changes
- Update documentation as needed
- Make sure all tests pass before submitting your pull request
If you're new to GitHub or open source contributions, check out these resources:
If you have any questions about contributing, feel free to:
- Ask in the issues section for specific problems