Skip to content

Conversation

Smponi
Copy link

@Smponi Smponi commented Apr 9, 2025

🚀 Description

Using this template might lead to a GitHub Action failure, which is discouraging and adds extra work before real development starts.

📄 Motivation and Context

When I set up a new repository with this template, I ran into this issue. I couldn’t find an answer within the repository, so this PR aims to help developers troubleshoot it more quickly.

🧪 How Has This Been Tested?

This update is a small addition to TROUBLESHOOTING.md, outlining the steps I took to resolve the problem.

📷 Screenshots (if appropriate)

📦 Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

✅ Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Comment on lines 39 to 41

Once the workflow completes successfully, you can and probably should revert the permissions back to the default settings.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure about this? This shouldn't be the case as by default the workflow runs with a token that has read/write access 🤔

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Valid observation. In my experience, the default setting is set to no write access, and I haven't changed anything. (I'm not even aware where this default can be modified 😅)

Additionally, some/several users have reported encountering this same behavior in this issue: ad-m/github-push-action#96

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see. Maybe we should add an image of the settings screen also then?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair point!

I've added 4 images. However, I don't really know how the template-feature of GitHub works, so I hope it's correct to put them in a new folder.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the best would be to use the GitHub assets url (basically the URL you get when you drag and drop an image in a comment box) rather than having the images in the repo as otherwise everyone will copy them (which is not ideal).

@Smponi Smponi marked this pull request as draft April 14, 2025 18:07
@Smponi Smponi requested a review from cortinico April 14, 2025 19:22
@Smponi Smponi marked this pull request as ready for review April 14, 2025 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants