226 |
227 | ```yaml
228 | on: push
229 | jobs:
230 | build:
231 | runs-on: ubuntu-latest
232 | steps:
233 | - uses: EndBug/add-and-commit@v9
234 | with:
235 | default_author: github_actions
236 | ```
237 |
238 | You can also use the `committer_name` and `committer_email` inputs to make it appear as if GitHub Actions is the committer, here are a couple of example steps:
239 |
240 | 
241 |
242 | ```yaml
243 | - uses: EndBug/add-and-commit@v9
244 | with:
245 | message: Show GitHub Actions logo
246 | committer_name: GitHub Actions
247 | committer_email: actions@github.com
248 | ```
249 |
250 | 
251 |
252 | ```yaml
253 | - uses: EndBug/add-and-commit@v9
254 | with:
255 | message: Show GitHub logo
256 | committer_name: GitHub Actions
257 | committer_email: 41898282+github-actions[bot]@users.noreply.github.com
258 | ```
259 |
260 | ### Array inputs
261 |
262 | Due to limitations in the GitHub action APIs, all inputs must be either strings or booleans.
263 | The action supports arrays in `add` and `remove`, but they have to be encoded as a string with a YAML flow sequence:
264 |
265 | ```yaml
266 | - uses: EndBug/add-and-commit@v9
267 | with:
268 | add: '["afile.txt", "anotherfile.txt"]'
269 | ```
270 |
271 | (note the single-quotes) or a YAML block sequence:
272 |
273 | ```yaml
274 | - uses: EndBug/add-and-commit@v9
275 | with:
276 | add: |
277 | - afile.txt
278 | - anotherfile.txt
279 | ```
280 |
281 | (Note the pipe character making it a multiline string.)
282 |
283 | ### Automated linting
284 |
285 | Do you want to lint your JavaScript files, located in the `src` folder, with ESLint, so that fixable changes are done without your intervention? You can use a workflow like this:
286 |
287 | ```yaml
288 | name: Lint source code
289 | on: push
290 |
291 | jobs:
292 | run:
293 | name: Lint with ESLint
294 | runs-on: ubuntu-latest
295 | steps:
296 | - name: Checkout repo
297 | uses: actions/checkout@v4
298 |
299 | - name: Set up Node.js
300 | uses: actions/setup-node@v4
301 |
302 | - name: Install dependencies
303 | run: npm install
304 |
305 | - name: Update source code
306 | run: eslint "src/**" --fix
307 |
308 | - name: Commit changes
309 | uses: EndBug/add-and-commit@v9
310 | with:
311 | author_name: Your Name
312 | author_email: mail@example.com
313 | message: 'Your commit message'
314 | add: '*.js'
315 | ```
316 |
317 | ### Running the action in a different directory
318 |
319 | If you need to run the action on a repository that is not located in [`$GITHUB_WORKSPACE`](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables), you can use the `cwd` option: the action uses a `cd` normal command, so the path should follow bash standards.
320 |
321 | ```yaml
322 | name: Use a different repository directory
323 | on: push
324 |
325 | jobs:
326 | run:
327 | name: Add a text file
328 | runs-on: ubuntu-latest
329 |
330 | steps:
331 | # If you need to, you can check out your repo to a different location
332 | - uses: actions/checkout@v4
333 | with:
334 | path: './pathToRepo/'
335 |
336 | # You can make whatever type of change to the repo...
337 | - run: echo "123" > ./pathToRepo/file.txt
338 |
339 | # ...and then use the action as you would normally do, but providing the path to the repo
340 | - uses: EndBug/add-and-commit@v9
341 | with:
342 | message: 'Add the very useful text file'
343 | add: '*.txt --force'
344 | cwd: './pathToRepo/'
345 | ```
346 |
347 | ## Articles
348 |
349 | - [Console by CodeSee #156](https://console.substack.com/p/console-156)
350 | - [MichealHeap.com](https://michaelheap.com/add-and-commit-action/)
351 |
352 | ## Contributors ✨
353 |
354 | Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
355 |
356 |
357 |
358 |
359 | 
