Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wayofdev/gh-actions
Shared github action workflows for usage in Wayofdev projects.
https://github.com/wayofdev/gh-actions
actions github-actions wayofdev wod
Last synced: 27 days ago
JSON representation
Shared github action workflows for usage in Wayofdev projects.
- Host: GitHub
- URL: https://github.com/wayofdev/gh-actions
- Owner: wayofdev
- License: mit
- Created: 2023-05-11T09:44:08.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-15T03:38:58.000Z (about 1 month ago)
- Last Synced: 2024-11-15T04:25:31.822Z (about 1 month ago)
- Topics: actions, github-actions, wayofdev, wod
- Language: Makefile
- Homepage: https://wayof.dev
- Size: 374 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Shared GitHub Actions
This repository is a collection of [reusable workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows) and [composite actions](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action), specifically designed for use in [wayofdev](https://github.com/wayofdev) projects.
These tools encapsulate common and repetitive tasks, allowing for easy integration into multiple projects. This approach not only reduces the need to rewrite code but also ensures standardized operations across all Wayofdev repositories.
## 📋 Table of Contents
- [Getting Started](#-getting-started)
- [Composite Actions](#-composite-actions)
- [Workflows](#-workflows)
- [Auto Label and Release Management](#-auto-label-and-release-management)
- [Docker Workflows](#-docker-workflows)
- [Code Architecture](#-code-architecture)
- [Static Analysis](#-static-analysis)
- [Security Policy](#-security-policy)
- [Contributing](#-want-to-contribute)
- [Social Links](#-social-links)
- [Contributors](#-contributors)
- [Useful Resources](#-useful-resources)
- [License](#%EF%B8%8F-license)
## 🚀 Getting Started
To use these workflows and actions, reference them directly from your project's workflows. Detailed instructions for each are provided below.
## 🔧 Composite Actions
Composite Actions are a powerful feature of GitHub Actions that allow you to create reusable actions using a combination of other actions, shell commands, or both.
This enables you to encapsulate a sequence of steps into a single action, making your workflows more modular, easier to maintain, and reducing duplication across your projects.
Composite Actions can accept inputs and use outputs, making them highly flexible and adaptable to various use cases.
Check each action's README file for detailed instructions on how to use it.
| **Action** | **Description** |
|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| [`composer/get-cache-directory`](./actions/composer/get-cache-directory/README.md) | Gets the Composer cache directory path and exports it as env variable. |
| [`composer/get-root-version`](./actions/composer/get-root-version/README.md) | determines the Composer root version based on the specified branch and exports it as env variable. |
| [`composer/install`](./actions/composer/install/README.md) | Installs dependencies with Composer based on the specified dependency level. |
| [`phive/install`](./actions/phive/install/README.md) | Install dependencies with [Phive](https://phar.io). |
| [`playwright/install`](./actions/playwright/install/README.md) | Installs [Playwright](https://playwright.dev/) along with its dependencies. |
| [`pnpm/install`](./actions/pnpm/install/README.md) | Installs mono-repository dependencies using [PNPM](https://pnpm.io/). |
| [`s3/cache`](./actions/s3/cache/README.md) | Cache artifacts, or restore them using S3. |
## 🔧 Workflows
Read more about [reusing workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows).
### → Auto Label and Release Management
#### `apply-labels.yml:`
Automatically applies labels to pull requests based on modified paths.
This workflow triages pull requests and applies labels based on the paths that are modified in the pull request. This can help to categorize your pull requests and make it easier to identify the type of changes included.
To use this workflow, set up a `.github/labeler.yml` file with your configuration in your project. For more information on how to configure the labeler, see:
Here is an example of how to use this workflow:
.github/workflows/apply-labels.yml
```yaml
---
on:
pull_request:
name: 🏷️ Add labels
jobs:
label:
uses: wayofdev/gh-actions/.github/workflows/apply-labels.yml@master
with:
os: ubuntu-latest
secrets:
token: ${{ secrets.GITHUB_TOKEN }}
...
```
.github/labeler.yml
```yaml
---
"type: bug":
- head-branch: ['^bug', '^fix', 'bug', 'fix']
"type: enhancement":
- head-branch: ['^feature', '^feat', 'feature']
"type: documentation":
- changed-files:
- any-glob-to-any-file: ['assets/**/*', '.github/*', './*.md']
"type: maintenance":
- changed-files:
- any-glob-to-any-file: ['tests/**/*', '.github/workflows/*']
...
```
Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/apply-labels.yml) repository.
#### `auto-merge-release.yml:`
This workflow automatically merges releases. This workflow utilizes [peter-evans/enable-pull-request-automerge](https://github.com/peter-evans/enable-pull-request-automerge) to auto-merge releases that are created by [googleapis/release-please](https://github.com/googleapis/release-please).
Here is an example of how to use this workflow:
.github/workflows/auto-merge-release.yml
```yaml
---
on: # yamllint disable-line rule:truthy
pull_request:
permissions:
pull-requests: write
contents: write
name: 🤞 Auto merge release
jobs:
auto-merge:
uses: wayofdev/gh-actions/.github/workflows/auto-merge-release.yml@master
with:
os: ubuntu-latest
pull-request-number: ${{ github.event.pull_request.number }}
actor: lotyp
merge-method: merge
secrets:
# to trigger other workflows, pass PAT token instead of GITHUB_TOKEN
token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
...
```
Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/auto-merge-release.yml) repository.
#### `create-changesets-release.yml:`
This workflow creates a release based on changesets. This workflow utilizes [changesets/action](https://github.com/changesets/action) to create a release based on changesets.
Here is an example of how to use this workflow:
.github/workflows/create-changesets-release.yml
```yaml
---
on: # yamllint disable-line rule:truthy
push:
branches:
- master
name: 🦋 Create release or publish to pnpm
jobs:
release:
uses: wayofdev/gh-actions/.github/workflows/create-changesets-release.yml@master
with:
node: 18
repository: wayofdev/next-starter-tpl
secrets:
# to trigger other workflows, pass PAT token instead of GITHUB_TOKEN
token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
npm_token: ${{ secrets.NPM_TOKEN }}
...
```
Real-world examples can be found in the [`wayofdev/next-starter-tpl`](https://github.com/wayofdev/next-starter-tpl/blob/master/.github/workflows/create-changesets-release.yml) repository.
### → Docker Workflows
#### `build-image.yml:`
This workflow builds a docker image and pushes it to the Docker Container Registry.
Example repositories, using this workflow:
- [wayofdev/docker-node](https://github.com/wayofdev/docker-node)
**Build image with "release" tag:**
.github/workflows/build-release.yml
```yaml
---
on: # yamllint disable-line rule:truthy
release:
types:
- released
name: 🚀 Build docker images with release tag
jobs:
prepare:
runs-on: "ubuntu-latest"
outputs:
matrix: ${{ steps.matrix.outputs.matrix }}
version: ${{ steps.version.outputs.version }}
steps:
- name: ⚙️ Generate matrix
id: matrix
run: |
echo 'matrix={
"os_name": ["alpine"],
"php_version": ["8.1", "8.2"],
"php_type": ["fpm", "cli", "supervisord"]
}' | tr -d '\n' >> $GITHUB_OUTPUT
- name: ⚙️ Get version for image tag
id: version
run: |
version=${{ github.ref_name }}
version=${version#v}
echo "version=$version" >> $GITHUB_OUTPUT
build:
needs: prepare
strategy:
matrix: ${{ fromJson(needs.prepare.outputs.matrix )}}
uses: wayofdev/gh-actions/.github/workflows/build-image.yml@master
with:
os: "ubuntu-latest"
push-to-hub: true
image-namespace: "wayofdev/php-base"
image-template-path: "./dist/base"
image-template: ${{ matrix.php_version }}-${{ matrix.php_type }}-${{ matrix.os_name }}
image-version: ${{ needs.prepare.outputs.version }}
secrets:
docker-username: ${{ secrets.DOCKER_USERNAME }}
docker-password: ${{ secrets.DOCKER_TOKEN }}
...
```
Real-world examples can be found in the [`wayofdev/docker-node`](https://github.com/wayofdev/docker-node/blob/master/.github/workflows/build-release.yml) repository.
### → Code Architecture
#### `create-arch-diagram.yml:`
This workflow leverages the [codesee-io/codesee-action](https://github.com/Codesee-io/codesee-action) action to automatically generate architecture diagrams for your codebase whenever a pull request is made.
CodeSee is an open-source tool that helps visualize your codebase and its dependencies, making it easier for new contributors to understand the project or for maintaining a clear view of your project's architecture over time.
Here is an example of how to use this workflow:
.github/workflows/create-arch-diagram.yml
```yaml
---
on: # yamllint disable-line rule:truthy
push:
branches:
- develop
pull_request_target:
types:
- opened
- synchronize
- reopened
name: 🤖 CodeSee
permissions: read-all
jobs:
codesee:
uses: wayofdev/gh-actions/.github/workflows/create-arch-diagram.yml@master
with:
os: ubuntu-latest
continue-on-error: true
secrets:
codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
...
```
Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/create-arch-diagram.yml) repository.
### → Static Analysis
#### `shellcheck.yml:`
This workflow uses [redhat-plumbers-in-action/differential-shellcheck](https://github.com/redhat-plumbers-in-action/differential-shellcheck) to run shell script analysis.
Here is an example of how to use this workflow:
.github/workflows/shellcheck.yml
```yaml
---
on: # yamllint disable-line rule:truthy
pull_request:
name: 🐞 Differential shell-check
permissions:
contents: read
jobs:
shellcheck:
uses: wayofdev/gh-actions/.github/workflows/shellcheck.yml@master
with:
os: ubuntu-latest
severity: warning
secrets:
token: ${{ secrets.GITHUB_TOKEN }}
...
```
Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/shellcheck.yml) repository.
## 🔒 Security Policy
This project has a [security policy](.github/SECURITY.md).
## 🙌 Want to Contribute?
Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to:
- 🤔 [Suggest a feature](https://github.com/wayofdev/gh-actions/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+)
- 🐛 [Report an issue](https://github.com/wayofdev/gh-actions/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+)
- 📖 [Improve documentation](https://github.com/wayofdev/gh-actions/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+)
- 👨💻 Contribute to the code
You are more than welcome. Before contributing, kindly check our [contribution guidelines](.github/CONTRIBUTING.md).
[](https://conventionalcommits.org)
## 🌐 Social Links
- **Twitter:** Follow our organization [@wayofdev](https://twitter.com/intent/follow?screen_name=wayofdev) and the author [@wlotyp](https://twitter.com/intent/follow?screen_name=wlotyp).
- **Discord:** Join our community on [Discord](https://discord.gg/CE3TcCC5vr).
## 🫡 Contributors
## 🧱 Useful Resources
- [Composite Actions vs Reusable Workflows: what is the difference?](https://dev.to/n3wt0n/composite-actions-vs-reusable-workflows-what-is-the-difference-github-actions-11kd)
- [cycle/gh-actions](https://github.com/cycle/gh-actions) — Downstream repository of reusable GitHub Actions for [Cycle](https://github.com/cycle) organization.
- [ergebnis/.github](https://github.com/ergebnis/.github) — Shareable actions of the [@ergebnis](https://github.com/ergebnis) organization.
- [skills/reusable-workflows](https://github.com/skills/reusable-workflows) — Reusable workflow examples
## ⚖️ License
[](./LICENSE.md)