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.

Sign up for GitHub

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

docs: adding the missing doc for gitlab-repo-scaffolding-golang #487

Merged
merged 1 commit into from
May 16, 2022
Merged

docs: adding the missing doc for gitlab-repo-scaffolding-golang #487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions docs/plugins/gitlab-repo-scaffolding-golang.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# gitlab-repo-scaffolding-golang Plugin

This plugin bootstraps a GitLab repo with scaffolding code for a Golang web application.

_This plugin depends on the following environment variable:_

- GITLAB_TOKEN

Set it before using this plugin.

If you don't know how to create this token, check out:
- [GitLab Personal Access Tokens](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)

*Tips:*

*1. If you run `dtm delete`, the repo on GitLab will be completely removed.*

*2. If the `Update` interface is called, the repo on GitLab will be completely removed and recreated.

## Usage

**Please note that the `owner` parameter is case-sensitive.**

```yaml
tools:
# name of the tool
- name: gitlab-repo-scaffolding-golang
# id of the tool instance
instanceID: default
# format: name.instanceID; If specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: []
# options for the plugin
options:
# the repo's owner. It should be case-sensitive here; strictly use your GitLab user name; please change the value below.
owner: YOUR_GITLAB_USERNAME
# the repo's org. If you set this property, then the new repo will be created under the org you're given, and the "owner" setting above will be ignored.
org: YOUR_ORGANIZATION_NAME
# the repo which you'd like to create; please change the value below.
repo: YOUR_REPO_NAME
# the branch of the repo you'd like to hold the code
branch: main
# the image repo you'd like to push the container image; please change the value below.
image_repo: YOUR_DOCKERHUB_USERNAME/YOUR_DOCKERHUB_REPOSITORY
```

Replace the following from the config above:

- `YOUR_GITLAB_USERNAME`
- `YOUR_ORGANIZATION_NAME`
- `YOUR_REPO_NAME`
- `YOUR_DOCKERHUB_USERNAME`
- `YOUR_DOCKERHUB_REPOSITORY`

The "branch" in the example above is "main", but you can adjust accordingly.

You have to specify either "owner" or "org".

## Outputs

This plugin has three outputs:

- `org`
- `owner`
- `repo`
- `repoURL` (example: "https://gitlab.com/ironcore864/dtm-app-test.git")
37 changes: 19 additions & 18 deletions docs/plugins/plugins-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
# Plugins List

| Type | Plugin | Note | Usage/Doc |
|--------------------------------|--------------------------------|--------------------------------|---------------------------------------|
| Issue Tracking | trello-github-integ | Trello/GitHub integration | [doc](trello-github-integ) |
| Issue Tracking | trello | Trello | [doc](trello) |
| Issue Tracking | jira-github-integ | Jira/GitHub integration | [doc](jira-github-integ) |
| Source Code Management | github-repo-scaffolding-golang | Go WebApp scaffolding | [doc](github-repo-scaffolding-golang) |
| CI | jenkins | Jenkins installation | [doc](jenkins) |
| CI | githubactions-golang | GitHub Actions CI for Golang | [doc](githubactions-golang) |
| CI | githubactions-python | GitHub Actions CI for Python | [doc](githubactions-python) |
| CI | githubactions-nodejs | GitHub Actions CI for Nodejs | [doc](githubactions-nodejs) |
| CI | gitlabci-golang | GitLab CI for Golang | [doc](gitlabci-golang) |
| CI | gitlabci-generic | Generic GitLab CI | [doc](gitlabci-generic) |
| CD/GitOps | argocd | ArgoCD installation | [doc](argocd) |
| CD/GitOps | argocdapp | ArgoCD Application creation | [doc](argocdapp) |
| Monitoring | kube-prometheus | Prometheus/Grafana K8s install | [doc](kube-prometheus) |
| Observability | devlake | DevLake installation | [doc](devlake) |
| LDAP | openldap | OpenLDAP installation | [doc](openldap) |
| Secrets/Credentials Management | hashicorp-vault | Hashicorp Vault installation | [doc](hashicorp-vault) |
| Type | Plugin | Note | Usage/Doc |
|--------------------------------|--------------------------------|--------------------------------|------------------------------------------|
| Issue Tracking | trello-github-integ | Trello/GitHub integration | [doc](trello-github-integ.md) |
| Issue Tracking | trello | Trello | [doc](trello.md) |
| Issue Tracking | jira-github-integ | Jira/GitHub integration | [doc](jira-github-integ.md) |
| Source Code Management | github-repo-scaffolding-golang | Go WebApp scaffolding | [doc](github-repo-scaffolding-golang.md) |
| Source Code Management | gitlab-repo-scaffolding-golang | Go WebApp scaffolding | [doc](gitlab-repo-scaffolding-golang.md) |
| CI | jenkins | Jenkins installation | [doc](jenkins.md) |
| CI | githubactions-golang | GitHub Actions CI for Golang | [doc](githubactions-golang.md) |
| CI | githubactions-python | GitHub Actions CI for Python | [doc](githubactions-python.md) |
| CI | githubactions-nodejs | GitHub Actions CI for Nodejs | [doc](githubactions-nodejs.md) |
| CI | gitlabci-golang | GitLab CI for Golang | [doc](gitlabci-golang.md) |
| CI | gitlabci-generic | Generic GitLab CI | [doc](gitlabci-generic.md) |
| CD/GitOps | argocd | ArgoCD installation | [doc](argocd.md) |
| CD/GitOps | argocdapp | ArgoCD Application creation | [doc](argocdapp.md) |
| Monitoring | kube-prometheus | Prometheus/Grafana K8s install | [doc](kube-prometheus.md) |
| Observability | devlake | DevLake installation | [doc](devlake.md) |
| LDAP | openldap | OpenLDAP installation | [doc](openldap.md) |
| Secrets/Credentials Management | hashicorp-vault | Hashicorp Vault installation | [doc](hashicorp-vault.md) |

Or, to get a list of plugins, run:

Expand Down