Skip to content

Commit aea3d5f

Browse files
PlaneshifterPlaneshifter
committed
build: add workflow to create Git note excluding packages
1 parent 2535ffd commit aea3d5f

File tree

2 files changed

+152
-2
lines changed

2 files changed

+152
-2
lines changed

‎.github/workflows/git_note_amend_message.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ on:
6666
jobs:
6767

6868
# Define a job to create a Git note amending a commit message:
69-
create_git_note:
69+
create_git_note_amending_commit_message:
7070

7171
# Define job name:
7272
name: 'Create Git Note Amending Commit Message'
@@ -106,7 +106,7 @@ jobs:
106106
EOF
107107
108108
# Append new commit message to Git note file:
109-
printf '%s\n' '${{ inputs.message }}' >> "docs/git-notes/${{ inputs.commit_hash }}.txt"
109+
echo -e '${{ inputs.message }}' >> "docs/git-notes/${{ inputs.commit_hash }}.txt"
110110
111111
# Create step summary:
112112
echo "## Note for commit ${{ inputs.commit_hash }}:" >> $GITHUB_STEP_SUMMARY

‎.github/workflows/git_note_filter_packages.yml

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2024 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
# Workflow name:
20+
name: git_note_filter_packages
21+
22+
# Workflow triggers:
23+
on:
24+
# Allow the workflow to be manually run:
25+
workflow_dispatch:
26+
# Define the input parameters for the workflow:a
27+
inputs:
28+
commit_hash:
29+
description: 'Commit hash to create note for'
30+
required: true
31+
type: string
32+
excludes:
33+
description: 'Comma-separated list of packages to exclude'
34+
required: true
35+
type: string
36+
37+
# Allow the workflow to be triggered by other workflows:
38+
workflow_call:
39+
# Define the input parameters for the workflow:
40+
inputs:
41+
commit_hash:
42+
description: 'Commit hash to create note for'
43+
required: true
44+
type: string
45+
excludes:
46+
description: 'Comma-separated list of packages to exclude'
47+
required: true
48+
type: string
49+
50+
# Define the secrets accessible by the workflow:
51+
secrets:
52+
STDLIB_BOT_GITHUB_TOKEN:
53+
description: 'GitHub token for stdlib-bot'
54+
required: true
55+
REPO_GITHUB_TOKEN:
56+
description: 'GitHub token for accessing the repository'
57+
required: true
58+
STDLIB_BOT_GPG_PRIVATE_KEY:
59+
description: 'GPG private key for stdlib-bot'
60+
required: true
61+
STDLIB_BOT_GPG_PASSPHRASE:
62+
description: 'GPG passphrase for stdlib-bot'
63+
required: true
64+
65+
# Workflow jobs:
66+
jobs:
67+
68+
# Define a job to create a Git note amending a commit message:
69+
create_git_note_filtering_packages:
70+
71+
# Define job name:
72+
name: 'Create Git Note Filtering Packages for Commit'
73+
74+
# Define the type of virtual host machine:
75+
runs-on: ubuntu-latest
76+
77+
# Define the sequence of job steps:
78+
steps:
79+
# Checkout the repository:
80+
- name: 'Checkout repository'
81+
# Pin action to full length commit SHA
82+
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
83+
with:
84+
# Fetch all history to allow creating a Git note for any commit:
85+
fetch-depth: 0
86+
87+
# Token for accessing the repository:
88+
token: ${{ secrets.REPO_GITHUB_TOKEN }}
89+
90+
# Verify commit exists:
91+
- name: 'Verify commit exists'
92+
run: |
93+
if ! git rev-parse --quiet --verify ${{ inputs.commit_hash }}^{commit}; then
94+
echo "Error: Commit ${{ inputs.commit_hash }} not found"
95+
exit 1
96+
fi
97+
98+
# Create Git note:
99+
- name: 'Create Git note'
100+
run: |
101+
# Start creating the note file:
102+
cat > "docs/git-notes/${{ inputs.commit_hash }}.txt" << 'EOF'
103+
---
104+
type: filter-packages
105+
exclude:
106+
EOF
107+
108+
# Process the comma-separated input and add each package as a YAML list item:
109+
echo "${{ inputs.excludes }}" | tr ',' '\n' | while IFS= read -r package; do
110+
# Trim whitespace and skip empty entries...
111+
package=$(echo "$package" | xargs)
112+
if [ -n "$package" ]; then
113+
echo " - $package" >> "docs/git-notes/${{ inputs.commit_hash }}.txt"
114+
fi
115+
done
116+
117+
# Add final YAML delimiter:
118+
echo "---" >> "docs/git-notes/${{ inputs.commit_hash }}.txt"
119+
120+
# Create step summary:
121+
echo "## Note for commit ${{ inputs.commit_hash }}:" >> $GITHUB_STEP_SUMMARY
122+
cat "docs/git-notes/${{ inputs.commit_hash }}.txt" >> $GITHUB_STEP_SUMMARY
123+
124+
# Disable Git hooks:
125+
- name: 'Disable Git hooks'
126+
run: |
127+
rm -rf .git/hooks
128+
129+
# Import GPG key to sign commits:
130+
- name: 'Import GPG key to sign commits'
131+
# Pin action to full length commit SHA
132+
uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
133+
with:
134+
gpg_private_key: ${{ secrets.STDLIB_BOT_GPG_PRIVATE_KEY }}
135+
passphrase: ${{ secrets.STDLIB_BOT_GPG_PASSPHRASE }}
136+
git_user_signingkey: true
137+
git_commit_gpgsign: true
138+
139+
# Commit and push changes:
140+
- name: 'Commit and push changes'
141+
env:
142+
REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
143+
USER_NAME: stdlib-bot
144+
run: |
145+
git config --local user.email "[email protected]"
146+
git config --local user.name "${USER_NAME}"
147+
148+
git add "docs/git-notes/${{ inputs.commit_hash }}.txt"
149+
git commit -m "docs: add Git note for commit ${{ inputs.commit_hash }}"
150+
git push

0 commit comments

Comments
 (0)