https://github.com/threatcode/automation
https://github.com/threatcode/automation
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/threatcode/automation
- Owner: threatcode
- License: mit
- Created: 2023-10-10T14:14:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-10T14:30:34.000Z (almost 2 years ago)
- Last Synced: 2025-02-10T07:18:29.706Z (5 months ago)
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ThreatCode Automation Tools
This repository contains GitHub Action workflows that are shared across repos in the `threatcode` GitHub org.
> **Warning**
> These workflows are not designed for use _outside_ of the `threatcode` GitHub org.
## [`congratsbot.yml`](./.github/workflows/congratsbot.yml)
This workflow posts a celebratory message in a Discord channel of your choice for each commit. For example:
> 🎊 **Merged!** Houston (Bot): [`[ci] release (#232)`](#)
> _Featuring contributions by github-actions[bot]! 🌟_
### Prerequisites
[Create a new Discord webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) and add the URL to your repository secrets as `DISCORD_WEBHOOK_CONGRATS`.
### Usage
```yml
name: Congratsbot
on:
push:
branches: [main]
jobs:
congrats:
if: ${{ github.repository_owner == 'threatcode' }}
uses: threatcode/automation/.github/workflows/congratsbot.yml@main
secrets:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_CONGRATS }}
```
### Optional inputs
You can customize the emojis and co-author message templates to give your repository its own personality. You can set these under `with` in your job:
```yml
jobs:
congrats:
if: ${{ github.repository_owner == 'threatcode' }}
uses: threatcode/automation/.github/workflows/congratsbot.yml@main
with:
EMOJIS: 🤖,👻,😱
COAUTHOR_TEMPLATES: >
[
"Woahhh, really gave us a fright! 🎃",
"We weren’t sure what we were doing until showed up. 🤝"
]
secrets:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_CONGRATS }}
```
#### `EMOJIS`
**default:** `🎉,🎊,🧑🚀,🥳,🙌,🚀`
A comma-delimited set of emojis.
Each congrats bot message will pick one at random for the start of the message.
#### `COAUTHOR_TEMPLATES`
**default:** see [`congratsbot.yml`](./.github/workflows/congratsbot.yml#L31)
A JSON array of co-author recognition templates.
Each template should contain the `` placeholder to be replaced by the names of one or more co-authors for this commit.
(Ignored for commits without any co-authors.)
When writing congrats messages, remember that `` could be one, two, or more names. So, create messages that can work for both a single co-author and for several people, for example, "This PR was made even better by ``!"
## [`format.yml`](./.github/workflows/format.yml)
This workflow runs a repository’s code formatting tooling (e.g. Prettier) and commits any resulting changes directly.
### Usage
```yml
name: Format
on:
workflow_dispatch:
push:
branches:
- main
jobs:
prettier:
if: github.repository_owner == 'threatcode'
uses: threatcode/automation/.github/workflows/format.yml@main
with:
# Set command to this repository’s package script that runs Prettier
command: 'format:ci'
secrets: inherit
```
## [`lockfile.yml`](./.github/workflows/lockfile.yml)
This workflow updates a repository’s `pnpm-lock.yaml` and opens a PR with the changes if there are any.
### Usage
```yml
name: Nightly
on:
workflow_dispatch:
schedule:
# Run every Monday at 12:00 UTC
- cron: '0 12 * * 1'
jobs:
lockfile:
if: github.repository_owner == 'threatcode'
uses: threatcode/automation/.github/workflows/lockfile.yml@main
secrets: inherit
```