Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify pull request flow by not having to run make release #864

Open
JensRantil opened this issue Nov 26, 2023 · 3 comments
Open

Simplify pull request flow by not having to run make release #864

JensRantil opened this issue Nov 26, 2023 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@JensRantil
Copy link
Contributor

Problem

I just submitted my first PR(s) to this repository. The pull request template asked me to execute make release in my pull request. I'm seeing multiple problems with this:

Proposed solution

  • Remove asking all developers to execute make release on every pull request.
  • Make Github Actions, execute this every time main is updated with a new commit.
@luizdepra
Copy link
Owner

Hmm.
Well, maybe we don't even need to commit the files that generate conflicts. So, we should test this hypothesis first.

@luizdepra luizdepra added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Nov 29, 2023
@simonhollingshead
Copy link
Contributor

maybe we don't even need to commit the files that generate conflicts

If you're talking about the files in /resources, then if you don't commit them, everyone has to compile the SCSS to use the theme and therefore everyone needs hugo-extended, whereas providing /resources means that people can use either hugo or hugo-extended. The BSD variants and Solaris don't support hugo-extended, but linux, windows and mac do.

If you didn't mind the fact that you'd end up having two successive commits every time you merge an SCSS change, it would be absolutely trivial to have a GitHub Action commit the replacement resources folder on any new commit on main (and also possibly on a daily/weekly schedule to (a) validate that there has been no concurrency issue previously and (b) to automatically rebuild with the latest version of hugo in case it generates a slightly different result).

@simonhollingshead
Copy link
Contributor

simonhollingshead commented Jan 24, 2024

Primarily as a proof of concept, I've written a github action for my fork for use on my 'patched' branch which, on a new commit or once per day 'corrects' the resources directory if any delta exists (or silently does nothing otherwise). I'm glad I've done so as it saves me merge conflicts for my own patches, I now no longer need to regenerate the resources as the action will do it for me.

https://github.com/simonhollingshead/hugo-coder/blob/patched/.github/workflows/regen-resources.yml

https://github.com/simonhollingshead/hugo-coder/actions/runs/7635526340/job/20801101769

simonhollingshead@9034a3e

The runner completes in around 20 seconds, where 10 of them are spent waiting for the runner to be started in the first place.

If you want a similar thing contributed back, let me know.

luizdepra pushed a commit that referenced this issue Apr 8, 2024
### Prerequisites

Put an `x` into the box(es) that apply:

- [ ] This pull request fixes a bug.
- [x] This pull request adds a feature.
- [ ] This pull request introduces breaking change.

### Description

This PR updates the version of Font Awesome used within the project from
6.5.1 Free to 6.5.2 Free. This adds additional characters.

The files are directly copied out of the published archive file with no
alterations.

Please note that the CSS regeneration also seems to have pulled in the
mastodon SCSS originally added in #885 - it looks like nobody
regenerated the CSS during that PR. For what it's worth, a while back I
did make a comment #864 about the fact that I have fully automated the
CSS regeneration for my own branch using a Github action. You may want
to consider it too (by which I mean 'tell me if you want it contributed
back').

### Issues Resolved

None

### Checklist

Put an `x` into the box(es) that apply:

#### General

- [x] Describe what changes are being made
- [x] Explain why and how the changes were necessary and implemented
respectively
- [ ] Reference issue with `#<ISSUE_NO>` if applicable

#### Resources

- [x] If you have changed any SCSS code, run `make release` to
regenerate all CSS files

#### Contributors

- [x] Add yourself to `CONTRIBUTORS.md` if you aren't on it already
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants