debian-mirror-gitlab/doc/user/project/repository/web_editor.md

204 lines
9 KiB
Markdown
Raw Normal View History

2019-10-12 21:52:04 +05:30
---
2020-10-24 23:57:45 +05:30
stage: Create
group: Editor
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
2019-10-12 21:52:04 +05:30
type: howto
---
2016-09-29 09:46:39 +05:30
# GitLab Web Editor
Sometimes it's easier to make quick changes directly from the GitLab interface
2020-11-24 15:15:51 +05:30
than to clone the project and use the Git command-line tool. In this feature
highlight, we look at how you can create a new file, directory, branch, or
2016-09-29 09:46:39 +05:30
tag from the file browser. All of these actions are available from a single
dropdown menu.
## Create a file
From a project's files page, click the '+' button to the right of the branch selector.
Choose **New file** from the dropdown.
![New file dropdown menu](img/web_editor_new_file_dropdown.png)
2020-11-24 15:15:51 +05:30
Enter a file name in the **Filename** box. Then, add file content in the editor
2016-09-29 09:46:39 +05:30
area. Add a descriptive commit message and choose a branch. The branch field
will default to the branch you were viewing in the file browser. If you enter
2020-11-24 15:15:51 +05:30
a new branch name, a checkbox will appear, allowing you to start a new merge
2016-09-29 09:46:39 +05:30
request after you commit the changes.
When you are satisfied with your new file, click **Commit Changes** at the bottom.
![Create file editor](img/web_editor_new_file_editor.png)
### Template dropdowns
2020-11-24 15:15:51 +05:30
When starting a new project, there are some common files that the new project
2016-09-29 09:46:39 +05:30
might need too. Therefore a message will be displayed by GitLab to make this
easy for you.
![First file for your project](img/web_editor_template_dropdown_first_file.png)
2020-11-24 15:15:51 +05:30
When clicking on either `LICENSE` or `.gitignore` and so on, a dropdown will be displayed
to provide you with a template that might be suitable for your project.
2016-09-29 09:46:39 +05:30
![MIT license selected](img/web_editor_template_dropdown_mit_license.png)
The license, changelog, contribution guide, or `.gitlab-ci.yml` file could also
2019-07-07 11:18:12 +05:30
be added through a button on the project page. In the example below, the license
2016-09-29 09:46:39 +05:30
has already been created, which creates a link to the license itself.
![New file button](img/web_editor_template_dropdown_buttons.png)
2020-10-24 23:57:45 +05:30
NOTE: **Note:**
2018-03-17 18:26:18 +05:30
The **Set up CI/CD** button will not appear on an empty repository. You have to at
2016-09-29 09:46:39 +05:30
least add a file in order for the button to show up.
## Upload a file
The ability to create a file is great when the content is text. However, this
2020-11-24 15:15:51 +05:30
doesn't work well for binary data such as images, PDFs, or other file types. In
this case, you need to upload a file.
2016-09-29 09:46:39 +05:30
From a project's files page, click the '+' button to the right of the branch
selector. Choose **Upload file** from the dropdown.
![Upload file dropdown menu](img/web_editor_upload_file_dropdown.png)
2020-11-24 15:15:51 +05:30
Once the upload dialog pops up, there are two ways to upload your file. Either
drag and drop a file on the popup or use the **click to upload** link. A file
2016-09-29 09:46:39 +05:30
preview will appear once you have selected a file to upload.
Enter a commit message, choose a branch, and click **Upload file** when you are
ready.
![Upload file dialog](img/web_editor_upload_file_dialog.png)
## Create a directory
To keep files in the repository organized it is often helpful to create a new
directory.
2020-04-08 14:13:33 +05:30
From a project's files page, click the plus button (`+`) to the right of the branch selector.
2016-09-29 09:46:39 +05:30
Choose **New directory** from the dropdown.
![New directory dropdown](img/web_editor_new_directory_dropdown.png)
2020-11-24 15:15:51 +05:30
In the new directory dialog, enter a directory name, a commit message, and choose
2016-09-29 09:46:39 +05:30
the target branch. Click **Create directory** to finish.
![New directory dialog](img/web_editor_new_directory_dialog.png)
## Create a new branch
There are multiple ways to create a branch from GitLab's web interface.
### Create a new branch from an issue
2020-04-22 19:07:51 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2808) in GitLab 8.6.
2020-04-08 14:13:33 +05:30
If your development workflow dictates to have an issue for every merge
request, you can quickly create a branch directly from the issue to speed the process up.
The new branch, and later its merge request, will be marked as related to this issue.
Once merged, the MR will automatically close the issue.
You can see a **Create merge request** dropdown below the issue description.
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
NOTE: **Note:**
You won't see the **Create merge request** button if there is already a branch with the same
name or a referenced merge request or your project has an active
fork relationship.
If you would like to make this button appear, a possible workaround is to [remove your project's
fork relationship](../settings/index.md#removing-a-fork-relationship). Once removed, the fork
2020-11-24 15:15:51 +05:30
relationship cannot be restored, and you will no longer be able to send merge requests to the source.
2016-09-29 09:46:39 +05:30
2020-01-01 13:55:28 +05:30
![Create Button](img/web_editor_new_branch_from_issue_create_button_v12_6.png)
2016-09-29 09:46:39 +05:30
2020-01-01 13:55:28 +05:30
This dropdown contains the options **Create merge request and branch** and **Create branch**.
![New Branch Button](img/web_editor_new_branch_from_issue_v_12_6.png)
Once you choose one of these options, a new branch or branch and merge request
2020-11-24 15:15:51 +05:30
will be created based on the default
branch of your project (by default, `master`). The branch name will be based on
the title of the issue, and as a prefix, it will have its internal ID. Thus, the example
2020-01-01 13:55:28 +05:30
screenshot above will create a branch named
`2-make-static-site-auto-deploy-and-serve`.
When you click the **Create branch** button in an empty
repository project, GitLab automatically creates a `master` branch, commits
a blank `README.md` file to it, and creates and redirects you to a new branch
based on the issue title.
2020-04-22 19:07:51 +05:30
If your [project is already configured with a deployment service](../integrations/overview.md),
2020-01-01 13:55:28 +05:30
such as Kubernetes, GitLab takes one step further and prompts you to set up
2020-04-22 19:07:51 +05:30
[auto deploy](../../../topics/autodevops/stages.md#auto-deploy)
2020-01-01 13:55:28 +05:30
by helping you create a `.gitlab-ci.yml` file.
2017-08-17 22:00:37 +05:30
2016-09-29 09:46:39 +05:30
After the branch is created, you can edit files in the repository to fix
the issue. When a merge request is created based on the newly created branch,
2019-09-30 21:07:59 +05:30
the description field will automatically display the [issue closing pattern](../issues/managing_issues.md#closing-issues-automatically)
2016-09-29 09:46:39 +05:30
`Closes #ID`, where `ID` the ID of the issue. This will close the issue once the
merge request is merged.
### Create a new branch from a project's dashboard
If you want to make changes to several files before creating a new merge
2020-11-24 15:15:51 +05:30
request, you can create a new branch upfront. From a project's files page,
2016-09-29 09:46:39 +05:30
choose **New branch** from the dropdown.
![New branch dropdown](img/web_editor_new_branch_dropdown.png)
Enter a new **Branch name**. Optionally, change the **Create from** field
2020-11-24 15:15:51 +05:30
to choose which branch, tag, or commit SHA this new branch will originate from.
2016-09-29 09:46:39 +05:30
This field will autocomplete if you start typing an existing branch or tag.
Click **Create branch** and you will be returned to the file browser on this new
branch.
![New branch page](img/web_editor_new_branch_page.png)
You can now make changes to any files, as needed. When you're ready to merge
2020-11-24 15:15:51 +05:30
the changes back to master, you can use the widget at the top of the screen.
2016-09-29 09:46:39 +05:30
This widget only appears for a period of time after you create the branch or
modify files.
![New push widget](img/web_editor_new_push_widget.png)
## Create a new tag
Tags are useful for marking major milestones such as production releases,
release candidates, and more. You can create a tag from a branch or a commit
SHA. From a project's files page, choose **New tag** from the dropdown.
![New tag dropdown](img/web_editor_new_tag_dropdown.png)
Give the tag a name such as `v1.0.0`. Choose the branch or SHA from which you
would like to create this new tag. You can optionally add a message and
2020-01-01 13:55:28 +05:30
release notes. The release notes section supports Markdown format and you can
2020-11-24 15:15:51 +05:30
also upload an attachment. Click **Create tag**, and you will be taken to the tag
2016-09-29 09:46:39 +05:30
list page.
![New tag page](img/web_editor_new_tag_page.png)
## Tips
2020-11-24 15:15:51 +05:30
When creating or uploading a new file or creating a new directory, you can
trigger a new merge request rather than committing directly to `master`. Enter
2016-09-29 09:46:39 +05:30
a new branch name in the **Target branch** field. You will notice a checkbox
appear that is labeled **Start a new merge request with these changes**. After
you commit the changes you will be taken to a new merge request form.
![Start a new merge request with these changes](img/web_editor_start_new_merge_request.png)
2018-12-05 23:21:45 +05:30
If you'd prefer _not_ to use your primary email address for commits created
through the web editor, you can choose to use another of your linked email
addresses from the **User Settings > Edit Profile** page.
2019-10-12 21:52:04 +05:30
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->