1
This commit is contained in:
131
README.md
131
README.md
@@ -1,78 +1,93 @@
|
||||
## Introduction
|
||||
# Yes.Blog
|
||||
|
||||
This is a simple pipeline example for a .NET Core application, showing just
|
||||
how easy it is to get up and running with .NET development using GitLab.
|
||||
|
||||
# Reference links
|
||||
|
||||
- [GitLab CI Documentation](https://docs.gitlab.com/ee/ci/)
|
||||
- [.NET Hello World tutorial](https://dotnet.microsoft.com/learn/dotnet/hello-world-tutorial/)
|
||||
## Getting started
|
||||
|
||||
If you're new to .NET you'll want to check out the tutorial, but if you're
|
||||
already a seasoned developer considering building your own .NET app with GitLab,
|
||||
this should all look very familiar.
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
|
||||
## What's contained in this project
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
|
||||
The root of the repository contains the out of the `dotnet new console` command,
|
||||
which generates a new console application that just prints out "Hello, World."
|
||||
It's a simple example, but great for demonstrating how easy GitLab CI is to
|
||||
use with .NET. Check out the `Program.cs` and `dotnetcore.csproj` files to
|
||||
see how these work.
|
||||
## Add your files
|
||||
|
||||
In addition to the .NET Core content, there is a ready-to-go `.gitignore` file
|
||||
sourced from the the .NET Core [.gitignore](https://github.com/dotnet/core/blob/master/.gitignore). This
|
||||
will help keep your repository clean of build files and other configuration.
|
||||
|
||||
Finally, the `.gitlab-ci.yml` contains the configuration needed for GitLab
|
||||
to build your code. Let's take a look, section by section.
|
||||
|
||||
First, we note that we want to use the official Microsoft .NET SDK image
|
||||
to build our project.
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
|
||||
```
|
||||
image: microsoft/dotnet:latest
|
||||
cd existing_repo
|
||||
git remote add origin http://192.168.1.101:8080/yesblog/Yes.blog.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
|
||||
We're defining two stages here: `build`, and `test`. As your project grows
|
||||
in complexity you can add more of these.
|
||||
## Integrate with your tools
|
||||
|
||||
```
|
||||
stages:
|
||||
- build
|
||||
- test
|
||||
```
|
||||
- [ ] [Set up project integrations](http://192.1168.1.101/yesblog/Yes.blog/-/settings/integrations)
|
||||
|
||||
Next, we define our build job which simply runs the `dotnet build` command and
|
||||
identifies the `bin` folder as the output directory. Anything in the `bin` folder
|
||||
will be automatically handed off to future stages, and is also downloadable through
|
||||
the web UI.
|
||||
## Collaborate with your team
|
||||
|
||||
```
|
||||
build:
|
||||
stage: build
|
||||
script:
|
||||
- "dotnet build"
|
||||
artifacts:
|
||||
paths:
|
||||
- bin/
|
||||
```
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
|
||||
Similar to the build step, we get our test output simply by running `dotnet test`.
|
||||
## Test and Deploy
|
||||
|
||||
```
|
||||
test:
|
||||
stage: test
|
||||
script:
|
||||
- "dotnet test"
|
||||
```
|
||||
Use the built-in continuous integration in GitLab.
|
||||
|
||||
This should be enough to get you started. There are many, many powerful options
|
||||
for your `.gitlab-ci.yml`. You can read about them in our documentation
|
||||
[here](https://docs.gitlab.com/ee/ci/yaml/).
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
|
||||
## Developing with Gitpod
|
||||
***
|
||||
|
||||
This template repository also has a fully-automated dev setup for [Gitpod](https://docs.gitlab.com/ee/integration/gitpod.html).
|
||||
# Editing this README
|
||||
|
||||
The `.gitpod.yml` ensures that, when you open this repository in Gitpod, you'll get a cloud workspace with .NET Core pre-installed, and your project will automatically be built and start running.
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
|
||||
## Suggestions for a good README
|
||||
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
Reference in New Issue
Block a user