Skip to content

Commit

Permalink
Merge pull request #26931 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Jul 20, 2023
2 parents 26df807 + e716046 commit 0c4e3a4
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Organizations owned by a {% data variables.product.prodname_ghe_server %} instan

## The app code must be able to access the {% data variables.product.prodname_github_app %} credentials for the instance

You app's code will need the credentials of the {% data variables.product.prodname_github_app %} that the {% data variables.product.prodname_ghe_server %} instance registered. It will also need the hostname of the instance. You have two options: get the credentials and hostname from the instance, or share the app code with the instance.
You app's code will need the credentials of the {% data variables.product.prodname_github_app %} that the {% data variables.product.prodname_ghe_server %} instance registered. It will also need the hostname of the instance. You have two options: get the credentials and hostname from the instance, or have the {% data variables.product.prodname_ghe_server %} customer host and manage a self-hostable version of the app.

### Get the credentials from the {% data variables.product.prodname_ghe_server %} instance

Expand All @@ -52,9 +52,11 @@ Disadvantages:

- The app developer must take precautions to avoid leaking data from the instance.

### Share the app code with the {% data variables.product.prodname_ghe_server %} instance
### Have the {% data variables.product.prodname_ghe_server %} customer host and manage a self-hostable version of the app

The app developer can share the code for their app with the instance. Then, the instance can host the code on their own servers.
The app developer can provide a self-hostable version of their app. Then, the site administrator can host the app according to app developer's setup and installation instructions.

The method by which the self-hostable version of the app is created and shared is up to the app developer and depends on technology that the app uses.

Advantages:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ allowTitleToDifferFromFilename: true

You can copy an existing project and use it as a template to save time configuring your views and custom fields.

When you copy a project, the new project will contain the same views and custom fields. You also have the option to copy existing draft issues. The new project will not contain the original project's items, workflows, insights, collaborators, or team and repository links.
When you copy a project, the new project will contain the same {% data reusables.projects.what-gets-copied %}. {% ifversion projects-v2-org-templates-improvements %}The new project will not contain the original project's items, collaborators, or team and repository links.{% else %}The new project will not contain the original project's items, workflows, insights, collaborators, or team and repository links.{% endif %}

{% ifversion projects-v2-org-templates %}{% data reusables.projects.org-templates %}{% endif %}

Expand All @@ -24,12 +24,13 @@ When you copy a project, the new project will contain the same views and custom
1. In the top-right, click {% octicon "kebab-horizontal" aria-label="More options" %} to open the menu.

![Screenshot showing a project's menu bar. The menu icon is highlighted with an orange outline.](/assets/images/help/projects-v2/open-menu.png)

1. In the menu, click {% octicon "copy" aria-hidden="true" %} **Make a copy**.
1. Optionally, if you want all draft issues to be copied with the project, in the "Make a copy" dialog, select **Draft issues will be copied if selected**.
1. Optionally, if you want all draft issues to be copied with the project, in the "Make a copy" dialog, select **Draft issues will be copied if selected**.{%- ifversion projects-v2-org-templates-improvements %}{%- else %}

![Screenshot showing the "Make a copy" form.](/assets/images/help/projects-v2/copy-project-form.png)

{%- endif %}
1. Under "Owner", select either the organization that will own the new project or your personal account.
1. Under "New project name", type the name of the new project.
1. Click **Copy project**.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can set a project as a template to share a pre-configured project with other

The projects you have marked as templates are made available in the "Select a template" pop-up window when other people create projects in your organization.

When someone creates a project from a template, the views, custom fields, and draft issues are copied from the template to the new project.
When someone creates a project from a template, the {% data reusables.projects.what-gets-copied %} are copied from the template to the new project.

## Setting a project as a template

Expand All @@ -41,7 +41,7 @@ You can filter the list of projects in your organization to only show projects s

## Copying a project as a template

If you have write or admin permissions for a project in your organization, you can choose to copy the project as a template. This will make a duplicate of the current project, copying the views, custom fields, and draft issues, and set that copied project as a template for your organization.
If you have write or admin permissions for a project in your organization, you can choose to copy the project as a template. This will make a duplicate of the current projectcopying the {% data reusables.projects.what-gets-copied %} —and set that copied project as a template for your organization.

{% data reusables.projects.project-settings %}
1. In the "Templates" section, click {% octicon "duplicate" aria-hidden="true" %} **Copy as template**.
Expand Down
7 changes: 7 additions & 0 deletions data/features/projects-v2-org-templates-improvements.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Issues 10697
# Extra data transferred in org templates and copying projects
versions:
fpt: '*'
ghec: '*'
ghes: '>=3.11'
ghae: '>=3.11'
1 change: 1 addition & 0 deletions data/reusables/projects/what-gets-copied.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% ifversion projects-v2-org-templates-improvements %}views, custom fields, draft issues and associated field values, configured workflows (except any auto-add workflows), and insights{% else %}views, custom fields, and draft issues{% endif %}

0 comments on commit 0c4e3a4

Please sign in to comment.