mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-06-11 10:05:02 +00:00
be1a9cc8da
# Description of Changes Please provide a summary of the changes, including: - **What was changed** - Removed individual `actions/create-github-app-token` steps and replaced them with a centralized `setup-bot` custom action across all workflows. - Updated steps to use `steps.setup-bot.outputs` instead of `steps.generate-token.outputs`. - Standardized step names and ordering (e.g. checkout before bot setup). - Simplified `sync_files.yml` by eliminating the `read_bot_entries` job and directly using `setup-bot` outputs. - Added or adjusted permissions where required (e.g. `repository-projects: write` in `licenses-update.yml`). - **Why the change was made** - To centralize and standardize GitHub App authentication logic, reduce duplication, and improve maintainability of CI workflows. - To ensure a consistent bot identity (app slug, token, committer/author) across all actions and PR automation. - To streamline workflow configurations and make future updates easier. --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
34 lines
1.2 KiB
YAML
34 lines
1.2 KiB
YAML
name: 'Setup GitHub App Bot'
|
|
description: 'Generates a GitHub App Token and configures Git for a bot'
|
|
inputs:
|
|
app-id:
|
|
description: 'GitHub App ID'
|
|
required: True
|
|
private-key:
|
|
description: 'GitHub App Private Key'
|
|
required: True
|
|
outputs:
|
|
token:
|
|
description: 'Generated GitHub App Token'
|
|
value: ${{ steps.generate-token.outputs.token }}
|
|
committer:
|
|
description: 'Committer string for Git'
|
|
value: "${{ steps.generate-token.outputs.app-slug }}[bot] <${{ steps.generate-token.outputs.app-slug }}[bot]@users.noreply.github.com>"
|
|
app-slug:
|
|
description: 'GitHub App slug'
|
|
value: ${{ steps.generate-token.outputs.app-slug }}
|
|
runs:
|
|
using: 'composite'
|
|
steps:
|
|
- name: Generate a GitHub App Token
|
|
id: generate-token
|
|
uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e # v2.0.6
|
|
with:
|
|
app-id: ${{ inputs.app-id }}
|
|
private-key: ${{ inputs.private-key }}
|
|
- name: Configure Git
|
|
run: |
|
|
git config --global user.name "${{ steps.generate-token.outputs.app-slug }}[bot]"
|
|
git config --global user.email "${{ steps.generate-token.outputs.app-slug }}[bot]@users.noreply.github.com"
|
|
shell: bash
|