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

237 lines
10 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
2021-02-22 17:27:13 +05:30
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/#assignments
2019-10-12 21:52:04 +05:30
type: howto
---
2021-04-17 20:07:23 +05:30
# GitLab Web Editor **(FREE)**
2016-09-29 09:46:39 +05:30
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)
2021-03-08 18:12:59 +05:30
Enter a filename 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
2021-03-11 19:13:27 +05:30
defaults to the branch you were viewing in the file browser. If you enter
a new branch name, a checkbox displays, 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)
2021-01-29 00:20:46 +05:30
### Shortcuts
2021-03-11 19:13:27 +05:30
You can use shortcuts when editing a file through the Web Editor. It uses the same shortcuts
as the Web IDE. For details, read the documentation for [Command Palette](../web_ide/index.md#command-palette).
2021-01-29 00:20:46 +05:30
2016-09-29 09:46:39 +05:30
### Template dropdowns
2020-11-24 15:15:51 +05:30
When starting a new project, there are some common files that the new project
2021-03-11 19:13:27 +05:30
might need. GitLab displays a message to help you:
2016-09-29 09:46:39 +05:30
![First file for your project](img/web_editor_template_dropdown_first_file.png)
2021-03-11 19:13:27 +05:30
When clicking on either `LICENSE` or `.gitignore` and so on, a dropdown displays
to provide you a template that may be suitable for your project:
2016-09-29 09:46:39 +05:30
![MIT license selected](img/web_editor_template_dropdown_mit_license.png)
2021-03-11 19:13:27 +05:30
The license, changelog, contribution guide, or `.gitlab-ci.yml` file can also
be added through a button on the project page. In this example, 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)
2021-02-22 17:27:13 +05:30
NOTE:
2021-03-11 19:13:27 +05:30
The **Set up CI/CD** button does not appear on an empty repository. For the button
to display, add a file to your repository.
2016-09-29 09:46:39 +05:30
2021-04-29 21:17:54 +05:30
## Highlight lines
2021-06-08 01:23:25 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56159) in GitLab 13.10 for GitLab SaaS instances.
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56159) in GitLab 13.11 for self-managed instances.
2021-04-29 21:17:54 +05:30
Web Editor enables you to highlight a single line by adding specially formatted
hash information to the URL's file path segment. For example, the file path segment
`MY_FILE.js#L3` instructs the Web Editor to highlight line 3.
The Web Editor also enables you to highlight multiple lines using a similar pattern. In
this case, the file path segment `MY_FILE.js#L3-10` instructs the Web Editor to
highlight lines 3 to 10 of the file.
You don't need to construct these lines manually. Instead, you can:
1. Hover over the number of a line you want to be highlighted when sharing.
1. Right-click the number with your mouse.
1. Click **Copy Link Address** in the context menu.
![Link to a line](img/web_editor_line_link_v13_10.png)
2016-09-29 09:46:39 +05:30
## Upload a file
The ability to create a file is great when the content is text. However, this
2021-03-11 19:13:27 +05:30
doesn't work well for binary data such as images, PDFs, or other binary file types. In
2020-11-24 15:15:51 +05:30
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
2021-03-11 19:13:27 +05:30
selector. Choose **Upload file** from the dropdown:
2016-09-29 09:46:39 +05:30
![Upload file dropdown menu](img/web_editor_upload_file_dropdown.png)
2021-03-11 19:13:27 +05:30
After 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. After you
select a file to upload, a file preview displays.
2016-09-29 09:46:39 +05:30
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
2021-02-22 17:27:13 +05:30
There are multiple ways to create a branch from the GitLab web interface.
2016-09-29 09:46:39 +05:30
### 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
2021-03-11 19:13:27 +05:30
If your development workflow requires an issue for every merge
request, you can create a branch directly from the issue to speed the process up.
The new branch, and later its merge request, are marked as related to this issue.
Once merged, the merge request closes the issue.
2020-04-08 14:13:33 +05:30
You can see a **Create merge request** dropdown below the issue description.
2016-09-29 09:46:39 +05:30
2021-03-11 19:13:27 +05:30
The **Create merge request** button doesn't display if:
- A branch with the same name already exists.
2021-04-17 20:07:23 +05:30
- A merge request already exists for this branch.
2021-03-11 19:13:27 +05:30
- Your project has an active fork relationship.
To make this button appear, one possible workaround is to
[remove your project's fork relationship](../settings/index.md#removing-a-fork-relationship).
After removal, the fork relationship cannot be restored. This project can no longer
be able to receive or send merge requests to the source project, or other forks.
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)
2021-03-11 19:13:27 +05:30
After selecting one of these options, a new branch or branch and merge request
is created based on your project's default branch. By default, this branch is `master`.
The branch name is based on an internal ID, and the issue title. The example
screenshot above creates a branch named
2020-01-01 13:55:28 +05:30
`2-make-static-site-auto-deploy-and-serve`.
When you click the **Create branch** button in an empty
2021-03-11 19:13:27 +05:30
repository project, GitLab performs these actions:
- Creates a `master` branch.
- Commits a blank `README.md` file to it.
- Creates and redirects you to a new branch based on the issue title.
- _If your project is [configured with a deployment service](../integrations/overview.md) like Kubernetes,_
GitLab prompts you to set up [auto deploy](../../../topics/autodevops/stages.md#auto-deploy)
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
2021-03-11 19:13:27 +05:30
the issue. When a merge request is created based on the newly-created branch,
the description field displays the [issue closing pattern](../issues/managing_issues.md#closing-issues-automatically)
`Closes #ID`, where `ID` is the ID of the issue. This closes the issue when the
2016-09-29 09:46:39 +05:30
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
2021-03-11 19:13:27 +05:30
request, you can create a new branch upfront.
2016-09-29 09:46:39 +05:30
2021-03-11 19:13:27 +05:30
1. From a project's files page, choose **New branch** from the dropdown.
2016-09-29 09:46:39 +05:30
2021-03-11 19:13:27 +05:30
![New branch dropdown](img/web_editor_new_branch_dropdown.png)
2016-09-29 09:46:39 +05:30
2021-03-11 19:13:27 +05:30
1. Enter a new **Branch name**.
1. (Optional) Change the **Create from** field to choose which branch, tag, or
commit SHA this new branch originates from. This field autocompletes if you
start typing an existing branch or tag.
1. Click **Create branch** to return to the file browser on this new branch.
![New branch page](img/web_editor_new_branch_page.png)
2016-09-29 09:46:39 +05:30
You can now make changes to any files, as needed. When you're ready to merge
2021-03-11 19:13:27 +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
2021-03-11 19:13:27 +05:30
Tags help you mark major milestones such as production releases and
release candidates. You can create a tag from a branch or a commit
SHA:
1. From a project's files page, choose **New tag** from the dropdown.
2016-09-29 09:46:39 +05:30
2021-03-11 19:13:27 +05:30
![New tag dropdown](img/web_editor_new_tag_dropdown.png)
2016-09-29 09:46:39 +05:30
2021-03-11 19:13:27 +05:30
1. Give the tag a name such as `v1.0.0`.
1. Choose the branch or SHA from which you want to create this new tag.
1. (Optional) Add a message and release notes. The release notes section supports
Markdown format.
1. (Optional) Upload an attachment.
1. Click **Create tag**, and GitLab redirects you to the tag list page.
2016-09-29 09:46:39 +05:30
2021-03-11 19:13:27 +05:30
![New tag page](img/web_editor_new_tag_page.png)
2016-09-29 09:46:39 +05:30
## Tips
2020-11-24 15:15:51 +05:30
When creating or uploading a new file or creating a new directory, you can
2021-03-11 19:13:27 +05:30
trigger a new merge request rather than committing directly to `master`:
1. Enter a new branch name in the **Target branch** field.
1. GitLab displays the **Start a new merge request with these changes** check box.
1. Commit your changes, and GitLab redirects you to a new merge request form.
2016-09-29 09:46:39 +05:30
2021-03-11 19:13:27 +05:30
![Start a new merge request with these changes](img/web_editor_start_new_merge_request.png)
2016-09-29 09:46:39 +05:30
2021-03-11 19:13:27 +05:30
If you'd prefer to not use your primary email address for commits created
2018-12-05 23:21:45 +05:30
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. -->