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

DOC: how to sync a repo when template is updated #37

Open
prjemian opened this issue Jan 21, 2025 · 1 comment · May be fixed by #38
Open

DOC: how to sync a repo when template is updated #37

prjemian opened this issue Jan 21, 2025 · 1 comment · May be fixed by #38
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@prjemian
Copy link
Collaborator

As described, this repository is a template for new instrument package repositories. The docs to create a new repo from this template state:

After you make your repository a template, anyone with access to the repository can generate a new repository with the same directory structure and files as your default branch. They can also choose to include all the other branches in your repository. Branches created from a template have unrelated histories, so you cannot create pull requests or merge between the branches.

While the new repo contains the same directories and files as the template repo, it lacks the commit history that permits PRs or merges.

Document the steps necessary to sync a new repo created from this template when the template is updated.

@prjemian prjemian added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 21, 2025
@prjemian
Copy link
Collaborator Author

There can be some nuance to the procedure. Someone has already tackled this with a GHA workflow: https://github.com/AndreasAugustin/actions-template-sync

@prjemian prjemian self-assigned this Jan 21, 2025
prjemian added a commit that referenced this issue Jan 21, 2025
@prjemian prjemian linked a pull request Jan 21, 2025 that will close this issue
prjemian added a commit that referenced this issue Jan 21, 2025
prjemian added a commit that referenced this issue Jan 21, 2025
@prjemian prjemian added this to the v1.0.0 release milestone Feb 10, 2025
prjemian added a commit that referenced this issue Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant