jamesgeorge007 / jamesgeorge007/github-activity-readme

Automatically commit re-generated build files on PR push events

Open
#108 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
953
Forks
241
PR merge metrics
No merged PRs in 30d

Description

The PR author is expected to re-generate the build by running `npm run build` and commit the changes. This adds friction and misses out on the cases with PRs opened by Dependabot. There are two approaches that I'm thinking of.

1. Update the existing workflow to commit the changes after generating the build to branches apart from `main`.
2. Author another workflow that gets triggered on push events on PRs that generate the build and commit the changes. The [existing workflow ](https://github.com/jamesgeorge007/github-activity-readme/blob/master/.github/workflows/node.js.yml)will only used for format checks.

We can use a GH Action like [git-auto-commit](https://github.com/stefanzweifel/git-auto-commit-action).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with .github/workflows/node.js.yml and trace how it currently runs format checks and the `npm run build` command. Compare updating that workflow with adding a push-triggered workflow, using git-auto-commit as the referenced option. Done means PR updates regenerate and commit build changes without applying this behavior to `main`, including PRs opened by Dependabot.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, javascript
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.