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

Fix the sync-template action to work #159

Merged
merged 6 commits into from
Mar 28, 2024
Merged

Fix the sync-template action to work #159

merged 6 commits into from
Mar 28, 2024

Conversation

JessicaS11
Copy link
Contributor

@JessicaS11 JessicaS11 commented Mar 27, 2024

After all the great additions last week, I tested the sync-to-template action on the tester repo. I ended up finding a few issues, fixed herein, as well as discovered a minor bug in the action itself. The PR opened by the action: https://github.com/ICESAT-2HackWeek/jupyterbook-template-tester/pull/2

A couple decision points:

  • Currently, we have cookiecutter.yaml as one of our excluded files because it gets filled in with event info. But, it got updated in the last week's edits. I'm inclined to think the case where an excluded file is updated is not worth a custom solution (it would be easy enough to simply edit or delete the .templatesyncignore file in the templated repo and run the action to open a PR with any changes). Thoughts? UPDATE: make any such changes manually or by triggering the update action from a branch with a modified .templatesyncignore file.
  • There is a flag in the action to check for existing, open PRs created by the action and "clean them up" (it's recommended to use with caution). Should we leave the default for now (which won't clean them up; I'm not sure if a new PR will be opened or it will just exit, with or without error)? UPDATE: we tried the is_pr_cleanup flag and it did not modify the open PR, just exited the action since the branch existed, so we're leaving as default.

@JessicaS11 JessicaS11 requested a review from jomey March 27, 2024 19:24
.templatesyncignore Show resolved Hide resolved
.github/workflows/template-sync.yaml Outdated Show resolved Hide resolved
@JessicaS11 JessicaS11 merged commit d33090f into main Mar 28, 2024
3 checks passed
@JessicaS11 JessicaS11 deleted the update-action-fixes branch March 28, 2024 20:01
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.

3 participants