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